### iOS Smoke App Setup

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-e2e.md

Initializes the Notification Service Extension (NSE) for iOS, installs pods, and prepares the Xcode workspace for building and running on a device. Ensure correct signing team is set in Xcode.

```bash
npx react-native-notify-kit init-nse --ios-path apps/smoke/ios
cd apps/smoke/ios && pod install
# Open NotifeeExample.xcworkspace in Xcode
# Set signing team for both NotifeeExample and NotifyKitNSE targets
# Build and run on device
```

--------------------------------

### Install and Build Project

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/CONTRIBUTING.md

Install project dependencies and build all packages, including native core and TypeScript.

```bash
yarn install
yarn build:all          # Build everything (native core + TypeScript)

```

--------------------------------

### Install Pods for iOS Project

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-execution-runbook.md

Navigate to the iOS directory of your project and install the necessary CocoaPods dependencies.

```bash
cd apps/smoke/ios
pod install
```

--------------------------------

### Start Smoke Test App

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/CONTRIBUTING.md

Start the Metro bundler for the smoke test application.

```bash
yarn smoke:start        # Start Metro bundler

```

--------------------------------

### Install Dependencies and Build Server SDK

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-e2e.md

Installs project dependencies and rebuilds the server SDK for the `yarn send:test:fcm` command. This is a prerequisite for sending test notifications.

```bash
# Install repo dependencies if needed
yarn install

# Rebuild the server SDK if dist is missing or stale
yarn build:rn:server
```

--------------------------------

### Initialize iOS Notification Service Extension with React Native CLI

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/fcm-mode.mdx

For bare React Native projects, use the `npx react-native-notify-kit init-nse` command to set up the Notification Service Extension. Follow this with `cd ios && pod install` to complete the native dependency setup.

```bash
npx react-native-notify-kit init-nse
cd ios && pod install
```

--------------------------------

### START_WORKOUT

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/reference/Enumeration.IOSIntentIdentifier.mdx

Identifier for starting a workout.

```APIDOC
## START_WORKOUT

### Description
Identifier for starting a workout.

### Value
`9`
```

--------------------------------

### Install Dependencies

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/fcm-mode.mdx

Install the necessary packages for React Native Notify Kit, Firebase App, and Firebase Messaging.

```bash
yarn add react-native-notify-kit @react-native-firebase/app @react-native-firebase/messaging
```

--------------------------------

### Troubleshoot iOS Pod Install Failures

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-execution-runbook.md

Solutions for common `pod install` failures on iOS, such as 'Unable to find host target' errors related to Podfile structure and dependency conflicts.

```markdown
### iOS — `pod install` fails

1. **"Unable to find host target"**: The CLI's Podfile patching creates a nested
   target inside the main app target. If the Podfile was manually modified, the
   nesting may be broken.
   Check: `cat apps/smoke/ios/Podfile | grep -A3 NotifyKitNSE`.
2. **Dependency conflict**: Run `pod install --repo-update`.
```

--------------------------------

### iOS Notification Service Extension Setup (Ruby)

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/README.md

Add this to your Podfile for manual setup of the Notification Service Extension in bare React Native projects.

```ruby
target 'YourNSETarget' do
  pod 'RNNotifeeCore', :path => '../node_modules/react-native-notify-kit'
end
```

--------------------------------

### Conventional Commits Examples

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/CONTRIBUTING.md

Provides examples of commit messages following the Conventional Commits format for different types and scopes.

```text
fix(android): handle null context in NotificationAlarmReceiver
feat(ios): add setNotificationConfig opt-out flag
docs: update migration guide

```

--------------------------------

### Run Smoke App Commands

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/apps/smoke/README.md

Execute these commands from the repository root to start and manage the smoke application.

```sh
yarn smoke:start
yarn smoke:android
yarn smoke:ios
```

--------------------------------

### START_PHOTO_PLAYBACK

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/reference/Enumeration.IOSIntentIdentifier.mdx

Identifier for starting photo playback.

```APIDOC
## START_PHOTO_PLAYBACK

### Description
Identifier for starting photo playback.

### Value
`21`
```

--------------------------------

### Quick Start: Display Local Notification

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/README.md

This snippet demonstrates the basic steps to request permissions, create an Android channel, and display a local notification.

```typescript
import notifee, { AndroidImportance } from 'react-native-notify-kit';

// 1. Request permission (required on Android 13+ and iOS)
await notifee.requestPermission();

// 2. Create a channel (Android only, required for Android 8+)
await notifee.createChannel({
  id: 'default',
  name: 'Default Channel',
  importance: AndroidImportance.HIGH,
});

// 3. Display a notification
await notifee.displayNotification({
  title: 'Hello',
  body: 'This is a local notification',
  android: { channelId: 'default' },
});
```

--------------------------------

### Install React Native NotifyKit with npm or Yarn

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/installation.mdx

Install the package at the root of your React Native project using either npm or Yarn.

```bash
# Using npm
npm install --save react-native-notify-kit

# Using Yarn
yarn add react-native-notify-kit
```

--------------------------------

### Install Expo Build Properties

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/installation.mdx

Install the expo-build-properties package to manage Android SDK versions in your Expo project.

```bash
npx expo install expo-build-properties
```

--------------------------------

### Rebuild Project for Autolinking

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/installation.mdx

After installation, rebuild your iOS and Android projects to ensure autolinking is applied correctly. For iOS, this includes installing pods.

```bash
# For iOS
cd ios/ && pod install --repo-update
npx react-native run-ios

# For Android
npx react-native run-android
```

--------------------------------

### Reinstall Pods for iOS

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/README.md

After updating the package and imports, navigate to the `ios` directory and run `pod install` to link the native dependencies.

```bash
cd ios && pod install
```

--------------------------------

### Conventional Commits Type and Scope Examples

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/CLAUDE.md

Illustrates the types and optional scopes for commit messages in the Conventional Commits format.

```text
<type>(<scope>): <subject>

Types: `fix`, `feat`, `docs`, `style`, `refactor`, `test`, `chore`, `build`
Scopes: `android`, `ios`, `expo` (optional)
```

--------------------------------

### Basic React Native Component Setup

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/displaying-a-notification.mdx

Sets up a basic React Native view with a button to trigger notification display. Ensure you have the 'react-native-notify-kit' library imported.

```javascript
import React from 'react';
import { View, Button } from 'react-native';
import notifee from 'react-native-notify-kit';

function Screen() {
  return (
    <View>
      <Button title="Display Notification" onPress={() => {}} />
    </View>
  );
}
```

--------------------------------

### Jest Configuration for Mocking (JavaScript)

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/README.md

Configure Jest to use the mock setup file and correctly transform modules for testing react-native-notify-kit.

```javascript
setupFiles: ['<rootDir>/jest.setup.js'],
transformIgnorePatterns: [
  'node_modules/(?!(jest-)?react-native|@react-native|react-native-notify-kit)'
],
```

--------------------------------

### Create an Interval Trigger

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/triggers.mdx

Set up a trigger that repeats at a specified interval, useful for implementing timers. This example creates a trigger that repeats every 30 minutes.

```javascript
import notifee, {
  IntervalTrigger,
  TriggerType,
  TimeUnit
} from 'react-native-notify-kit';

const trigger: IntervalTrigger = {
  type: TriggerType.INTERVAL,
  interval: 30,
  timeUnit: TimeUnit.MINUTES
};
```

--------------------------------

### Platform Branching Example

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/packages/react-native/CLAUDE.md

Shows how to conditionally execute code based on the target platform (Android or iOS) using React Native's Platform module.

```typescript
import { Platform } from 'react-native';
const isAndroid = Platform.OS === 'android';
const isIOS = Platform.OS === 'ios';
```

--------------------------------

### Update Podfile for Notification Service Extension

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/apps/smoke/NOTIFICATION_SERVICE_EXTENSION.md

Add the NotifeeNSE target to your `ios/Podfile` to include the RNNotifeeCore dependency. After updating the Podfile, run `pod install` in the `ios` directory.

```ruby
target 'NotifeeNSE' do
  pod 'RNNotifeeCore', :path => '../node_modules/react-native-notify-kit'
end
```

--------------------------------

### Get Power Manager Info and Open Settings

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/reference/Interface.ModuleWithStatics.mdx

Retrieves information about the device's power manager settings and attempts to open them. This is useful for guiding users to adjust background restrictions. The 'activity' property indicates if a known settings screen exists.

```javascript
import notifee from 'react-native-notify-kit';

const powerManagerInfo = await notifee.getPowerManagerInfo();

if (powerManagerInfo.activity) {
 // 1. ask the user to adjust their Power Manager settings
 // ...

 // 2. open settings best-effort
 await notifee.openPowerManagerSettings();
}
```

--------------------------------

### Get Power Manager Info and Open Settings

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/android/background-restrictions.mdx

Retrieves information about the device's power manager and, if a vendor-specific activity is found, prompts the user to open the relevant settings screen. This is useful for ensuring notifications are delivered by guiding users to disable battery optimizations.

```javascript
const powerManagerInfo = await notifee.getPowerManagerInfo();
if (powerManagerInfo.activity) {
  Alert.alert(
    'Restrictions Detected',
    'To ensure notifications are delivered, please adjust your settings to prevent the app from being killed',
    [
      {
        text: 'OK, open settings',
        onPress: async () => await notifee.openPowerManagerSettings(),
      },
      {
        text: 'Cancel',
        onPress: () => console.log('Cancel Pressed'),
        style: 'cancel',
      },
    ],
    { cancelable: false },
  );
}
```

--------------------------------

### Local Development Workflow

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/fcm-mode.mdx

Commands to prebuild the iOS project and run it on a device for local development. This is necessary because Expo Go cannot load the generated native extension.

```bash
npx expo prebuild --platform ios
npx expo run:ios --device
```

--------------------------------

### Verify NSE Files Creation

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-execution-runbook.md

After initialization, verify that the Notification Service Extension files have been created in the expected directory.

```bash
ls apps/smoke/ios/NotifyKitNSE/
```

```bash
cat apps/smoke/ios/NotifyKitNSE/NotificationService.swift | grep withContent
```

--------------------------------

### Get Notification Settings

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/reference/Interface.ModuleWithStatics.mdx

Gets the current notification settings for the application on the device. Behavior varies between Android versions and iOS.

```javascript
const settings = await notifee.getNotificationSettings();
```

--------------------------------

### Build All Packages

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/CLAUDE.md

Builds all core and React Native packages. Use this command to ensure all components are compiled.

```bash
yarn build:all                  # Build everything (core + RN)
```

--------------------------------

### Start Metro Bundler for Android Smoke App

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-execution-runbook.md

Starts the Metro bundler with cache reset for the Android smoke application. Run from the 'apps/smoke' directory.

```bash
cd apps/smoke && npx react-native start --reset-cache
```

--------------------------------

### Initialize NotifyKit NSE for iOS

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-execution-runbook.md

Run the CLI to initialize the Notification Service Extension for iOS. This command sets up the necessary files and configurations within your iOS project.

```bash
node packages/cli/dist/cli.js init-nse --ios-path apps/smoke/ios
```

--------------------------------

### Clean Prebuild for Expo

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/fcm-mode.mdx

Command to perform a clean prebuild for Expo projects, useful when native folders were generated before adding the notification plugin.

```bash
npx expo prebuild --clean --platform ios
```

--------------------------------

### Initialize iOS Notification Service Extension (Bare React Native)

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/fcm-mode.mdx

Use the CLI command to set up the Notification Service Extension for bare React Native projects. This command automates the creation of necessary files and modifies your project's Podfile and Xcode project configuration.

```bash
npx react-native-notify-kit init-nse
cd ios && pod install

```

--------------------------------

### Firebase Cloud Functions Example

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/fcm-mode.mdx

This TypeScript example shows how to send a notification using React Native Notify Kit within a Firebase Cloud Function triggered by a new Firestore document. It constructs the FCM message payload and sends it using the Firebase Admin SDK.

```ts
// functions/src/index.ts
import { onDocumentCreated } from 'firebase-functions/v2/firestore';
import { buildNotifyKitPayload } from 'react-native-notify-kit/server';
import * as admin from 'firebase-admin';

admin.initializeApp();

export const onOrderCreated = onDocumentCreated('orders/{orderId}', async event => {
  const order = event.data?.data();
  if (!order?.deviceToken) return;

  const message = buildNotifyKitPayload({
    token: order.deviceToken,
    notification: {
      id: `order-${event.params.orderId}`,
      title: 'Order received',
      body: `We're preparing ${order.itemName}`,
      data: { orderId: event.params.orderId },
      android: { channelId: 'orders' },
      ios: { sound: 'default', interruptionLevel: 'timeSensitive' },
    },
    options: { androidPriority: 'high', ttl: 3600 },
  });

  await admin.messaging().send(message);
});
```

--------------------------------

### Configure iOS Podfile for Development

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/CLAUDE.md

Sets environment variables in the consuming app's Podfile to use local core sources for live development or the Notification Service Extension.

```bash
# For live development:
$NotifeeCoreFromSources=true

# For Notification Service Extension:
$NotifeeExtension=true
```

--------------------------------

### Get Badge Count

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/ios/badges.mdx

Retrieves the current badge count displayed on the application icon.

```APIDOC
## getBadgeCount

### Description
Retrieves the current badge count displayed on the application icon.

### Method
`getBadgeCount(): Promise<number>`

### Returns
- **Promise<number>** - A promise that resolves with the current badge count.
```

--------------------------------

### Get Badge Count

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/ios/badges.mdx

Retrieves the current badge count displayed on the application icon.

```javascript
notifee.getBadgeCount().then(count => console.log('Current badge count: ', count));
```

--------------------------------

### Clear Logcat

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/scripts/smoke-test-734-scenarios.md

Clears the Android logcat buffer. Use this before starting a scenario to isolate logs.

```bash
scripts/smoke-test-734.sh logcat-clear
```

--------------------------------

### Full Notifee Options Schema Example

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/fcm-mode.mdx

This JSON structure represents the full schema for notifee_options, including Android and iOS specific configurations for channels, icons, colors, actions, styles, sounds, and attachments.

```jsonc
{
  "_v": 1,
  "title": "Order received",
  "body": "We're preparing your food.",

  "android": {
    "channelId": "orders",
    "smallIcon": "ic_notification",
    "largeIcon": "https://cdn.example.com/avatar.png",
    "color": "#4CAF50",
    "pressAction": { "id": "open-order", "launchActivity": "default" },
    "actions": [
      { "title": "Accept", "pressAction": { "id": "accept" } },
      { "title": "Decline", "pressAction": { "id": "decline" }, "input": true },
    ],
    "style": { "type": "BIG_TEXT", "text": "Long body text ..." },
  },

  "ios": {
    "sound": "default",
    "categoryId": "ORDER_UPDATE",
    "threadId": "orders-thread",
    "interruptionLevel": "timeSensitive",
    "attachments": [
      { "url": "https://cdn.example.com/orders/42.png", "identifier": "attachment-0" },
    ],
  },
}
```

--------------------------------

### START_CALL

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/reference/Enumeration.IOSIntentIdentifier.mdx

Identifier for starting a call. This is a unified identifier that replaces separate audio and video call intents.

```APIDOC
## START_CALL

### Description
Start a call intent. Maps to Apple's unified `INStartCallIntentIdentifier`.

### Value
`25`
```

--------------------------------

### Run App-Local Commands

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/apps/smoke/README.md

Use these commands from the workspace directory for app-specific operations.

```sh
yarn start
yarn android
yarn ios
```

--------------------------------

### getBadgeCount

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/reference/Interface.ModuleWithStatics.mdx

Get the current badge count value for this application on the current device. Returns `0` on Android.

```APIDOC
## getBadgeCount()

### Description
Get the current badge count value for this application on the current device. Returns `0` on Android.

### Method
getBadgeCount

### Returns
`Promise<number>`

### Platform
ios

### Inherited from
`Module.getBadgeCount`
```

--------------------------------

### Define Quick Action to Open App in Foreground

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/ios/interaction.mdx

Configure a notification action to open the application in the foreground when pressed. This is achieved by setting the 'foreground' property to true on the action.

```javascript
async function setCategories() {
  await notifee.setNotificationCategories([
    {
      id: 'message',
      actions: [
        {
          id: 'view-post',
          title: 'View post',
          // Trigger the app to open in the foreground
          foreground: true,
        },
      ],
    },
  ]);
}
```

--------------------------------

### Update Imports from @notifee/react-native

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/README.md

After installing react-native-notify-kit, update all import statements in your codebase to reference the new package name.

```diff
- import notifee from '@notifee/react-native';
+ import notifee from 'react-native-notify-kit';
```

--------------------------------

### Configure Service Account Key

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-e2e.md

Instructions for setting up the Firebase service account key required for sending test notifications. The key should be downloaded from the Firebase Console and saved in the repository root.

```bash
# Set up service account key
# Download from Firebase Console > Project Settings > Service Accounts
# Save as firebase-notifykittest.json in the repo root
```

--------------------------------

### Add Firebase Dependencies

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/README.md

Install the necessary Firebase packages for your React Native application. This is a prerequisite for using Firebase messaging.

```bash
yarn add @react-native-firebase/app @react-native-firebase/messaging
```

--------------------------------

### Open Xcode Workspace

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/f4-hardware-execution-runbook.md

Open the Xcode workspace to configure and build the iOS application.

```bash
open NotifeeExample.xcworkspace
```

--------------------------------

### getNotificationSettings

Source: https://github.com/marcocrupi/react-native-notify-kit/blob/main/docs/react-native/reference/Interface.ModuleWithStatics.mdx

Gets the current notification settings for the application on the device. Behavior varies between Android versions regarding authorization status.

```APIDOC
## getNotificationSettings()

### Description
Get the current notification settings for this application on the current device. On Android 13+ (API 33+), `authorizationStatus` returns `AuthorizationStatus.NOT_DETERMINED` before `requestPermission()` is called, `AuthorizationStatus.DENIED` if denied, or `AuthorizationStatus.AUTHORIZED` if granted. On Android < 13, returns only `DENIED` or `AUTHORIZED`. All properties on the `IOSNotificationSettings` interface response return as `AUTHORIZED` on Android.

### Method
`Promise<NotificationSettings>`

### Returns
`Promise<NotificationSettings>`
```