@loyalytics/swan-react-native-sdk 2.0.1

package/scripts/setup-ios-extension.js

@@ -0,0 +1,275 @@
+#!/usr/bin/env node
+
+/**
+ * Swan SDK - iOS Notification Service Extension Setup Script
+ *
+ * This script automates the setup of the Notification Service Extension for iOS.
+ * It:
+ * 1. Copies extension files to the iOS app directory
+ * 2. Generates setup instructions for Xcode configuration
+ * 3. Validates dependencies
+ *
+ * Usage:
+ *   node node_modules/swan-react-native-sdk/scripts/setup-ios-extension.js
+ *   OR
+ *   npm run swan-setup-ios-extension
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+const colors = {
+  reset: '\x1b[0m',
+  bright: '\x1b[1m',
+  red: '\x1b[31m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  blue: '\x1b[34m',
+  cyan: '\x1b[36m',
+};
+
+function log(message, color = colors.reset) {
+  console.log(`${color}${message}${colors.reset}`);
+}
+
+function logSuccess(message) {
+  log(`✅ ${message}`, colors.green);
+}
+
+function logError(message) {
+  log(`❌ ${message}`, colors.red);
+}
+
+function logWarning(message) {
+  log(`⚠️  ${message}`, colors.yellow);
+}
+
+function logInfo(message) {
+  log(`ℹ️  ${message}`, colors.cyan);
+}
+
+function logStep(step, message) {
+  log(`\n${colors.bright}Step ${step}: ${message}${colors.reset}`);
+}
+
+function copyFileOrDirectory(src, dest) {
+  const stat = fs.statSync(src);
+
+  if (stat.isDirectory()) {
+    // Create directory if it doesn't exist
+    if (!fs.existsSync(dest)) {
+      fs.mkdirSync(dest, { recursive: true });
+    }
+
+    // Copy all files in directory
+    const files = fs.readdirSync(src);
+    files.forEach(file => {
+      const srcPath = path.join(src, file);
+      const destPath = path.join(dest, file);
+      copyFileOrDirectory(srcPath, destPath);
+    });
+  } else {
+    // Copy file
+    const destDir = path.dirname(dest);
+    if (!fs.existsSync(destDir)) {
+      fs.mkdirSync(destDir, { recursive: true });
+    }
+    fs.copyFileSync(src, dest);
+  }
+}
+
+// Main setup function
+function setup() {
+  log('\n' + '='.repeat(60), colors.bright);
+  log('Swan SDK - iOS Notification Service Extension Setup', colors.bright);
+  log('='.repeat(60) + '\n', colors.bright);
+
+  // Step 1: Validate environment
+  logStep(1, 'Validating environment');
+
+  // Find project root
+  let projectRoot = process.cwd();
+
+  // Check if ios/ directory exists
+  const iosDir = path.join(projectRoot, 'ios');
+  if (!fs.existsSync(iosDir)) {
+    logError('iOS directory not found! This script must be run from a React Native project root.');
+    logError('Expected directory: ' + iosDir);
+    process.exit(1);
+  }
+  logSuccess('iOS directory found');
+
+  // Check if package.json exists
+  const packageJsonPath = path.join(projectRoot, 'package.json');
+  if (!fs.existsSync(packageJsonPath)) {
+    logError('package.json not found! Run this script from your project root.');
+    process.exit(1);
+  }
+
+  // Read package.json to get project name
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+  const projectName = packageJson.name;
+  logSuccess(`Project name: ${projectName}`);
+
+  // Find SDK directory
+  const sdkDir = path.join(projectRoot, 'node_modules', 'swan-react-native-sdk');
+  if (!fs.existsSync(sdkDir)) {
+    logError('swan-react-native-sdk not found in node_modules!');
+    logError('Make sure the SDK is installed: npm install swan-react-native-sdk');
+    process.exit(1);
+  }
+  logSuccess('Swan SDK found');
+
+  // Step 2: Check dependencies
+  logStep(2, 'Checking dependencies');
+
+  const dependencies = packageJson.dependencies || {};
+  const devDependencies = packageJson.devDependencies || {};
+  const allDeps = { ...dependencies, ...devDependencies };
+
+  const requiredDeps = {
+    'react-native-shared-group-preferences': '^1.1.24',
+  };
+
+  const missingDeps = [];
+  for (const [dep, version] of Object.entries(requiredDeps)) {
+    if (!allDeps[dep]) {
+      missingDeps.push(`${dep}@${version}`);
+    } else {
+      logSuccess(`${dep} is installed`);
+    }
+  }
+
+  if (missingDeps.length > 0) {
+    logWarning('Missing required dependencies:');
+    missingDeps.forEach(dep => {
+      log(`  - ${dep}`, colors.yellow);
+    });
+    logInfo('Install missing dependencies with:');
+    log(`  npm install ${missingDeps.join(' ')}`, colors.cyan);
+    log('');
+  }
+
+  // Step 3: Copy extension files
+  logStep(3, 'Copying Notification Service Extension files');
+
+  const extensionSrcDir = path.join(sdkDir, 'ios', 'SwanNotificationServiceExtension');
+  const extensionDestDir = path.join(iosDir, 'SwanNotificationServiceExtension');
+
+  if (fs.existsSync(extensionDestDir)) {
+    logWarning('SwanNotificationServiceExtension directory already exists');
+    logInfo('Overwriting existing files...');
+  }
+
+  try {
+    copyFileOrDirectory(extensionSrcDir, extensionDestDir);
+    logSuccess('Extension files copied successfully');
+    logInfo(`Destination: ${extensionDestDir}`);
+  } catch (error) {
+    logError(`Failed to copy extension files: ${error.message}`);
+    process.exit(1);
+  }
+
+  // Step 4: Generate manual setup instructions
+  logStep(4, 'Setup Instructions');
+
+  log('\n' + '─'.repeat(60), colors.cyan);
+  log('IMPORTANT: Manual Xcode Configuration Required', colors.bright + colors.yellow);
+  log('─'.repeat(60) + '\n', colors.cyan);
+
+  log('The extension files have been copied to your ios/ directory.', colors.cyan);
+  log('You must now complete the setup in Xcode:\n');
+
+  const instructions = [
+    {
+      title: '1. Add Extension Target to Xcode (REQUIRED FIRST)',
+      steps: [
+        'Open your project in Xcode: ios/*.xcworkspace',
+        'In Xcode, go to File → New → Target',
+        'Choose "Notification Service Extension"',
+        'Product Name: SwanNotificationServiceExtension',
+        'Language: Swift',
+        'Click Finish',
+        'When prompted "Activate scheme?", click "Cancel"',
+        'STOP HERE: If you have not done this, the next steps will fail or be overwritten.',
+      ]
+    },
+    {
+      title: '2. Verify Files in Xcode Project',
+      steps: [
+        'The script has copied the Swan implementation files to: ios/SwanNotificationServiceExtension/',
+        'This should have overwritten the default files created by Xcode for the target.',
+        'In Xcode Project Navigator, expand `SwanNotificationServiceExtension` folder.',
+        'Verify that `NotificationService.swift`, `Info.plist`, and `SwanNotificationServiceExtension.entitlements` are present and contain the SwanSDK code.',
+        'If any files are missing from the Xcode Project Navigator (even if they exist on disk), right-click on the `SwanNotificationServiceExtension` folder in Xcode and choose "Add Files to YourProject" to re-add them, making sure "Add to target: SwanNotificationServiceExtension" is checked and "Copy items if needed" is UNCHECKED.',
+      ]
+    },
+    {
+      title: '3. Configure App Groups',
+      steps: [
+        'Select your main app target',
+        'Go to "Signing & Capabilities" tab',
+        'Click "+ Capability" and add "App Groups"',
+        'Click "+" under App Groups and add: group.swan.sdk.notifications',
+        'Now select SwanNotificationServiceExtension target',
+        'Go to "Signing & Capabilities" tab',
+        'Click "+ Capability" and add "App Groups"',
+        'Click "+" under App Groups and add: group.swan.sdk.notifications',
+        '(IMPORTANT: Both targets must have the SAME App Group ID)',
+      ]
+    },
+    {
+      title: '4. Build and Test',
+      steps: [
+        'Build your app: Product → Build (Cmd+B)',
+        'Archive your app: Product → Archive',
+        'Test on a REAL device (push doesn\'t work on simulator)',
+        'Send a test notification and check Xcode console for logs',
+        'Look for: [SwanSDK Extension] logs',
+      ]
+    }
+  ];
+
+  instructions.forEach((section, index) => {
+    log(`\n${colors.bright}${section.title}${colors.reset}`, colors.blue);
+    log('─'.repeat(60), colors.blue);
+    section.steps.forEach((step, stepIndex) => {
+      if (step.startsWith('{') || step.startsWith('[')) {
+        // JSON code block
+        log(`   ${colors.yellow}${step}${colors.reset}`);
+      } else {
+        log(`   ${stepIndex + 1}. ${step}`);
+      }
+    });
+  });
+
+  log('\n' + '─'.repeat(60), colors.cyan);
+  log('Troubleshooting', colors.bright);
+  log('─'.repeat(60) + '\n', colors.cyan);
+
+  log('If extension logs don\'t appear:', colors.yellow);
+  log('  • Make sure App Groups are configured in BOTH targets');
+  log('  • Verify App Group ID matches: group.swan.sdk.notifications');
+  log('  • Check that mutable-content: 1 is in FCM APNS payload');
+  log('  • Extension only runs for APNS notifications with mutable-content');
+  log('  • Test on a real device, not simulator\n');
+
+  log('If you see "CocoaPods Error: Unable to find compatibility version string for object version 70":', colors.yellow);
+  log('  • In Xcode, select your Project → Build Settings → Project Format');
+  log('  • Set it to "Xcode 16.0-compatible" or later\n');
+
+  log('For detailed documentation, see:', colors.cyan);
+  log('  node_modules/swan-react-native-sdk/docs/IOS_NOTIFICATION_EXTENSION_SETUP.md\n');
+
+  logSuccess('Setup script completed!');
+  log('');
+}
+
+// Run setup
+try {
+  setup();
+} catch (error) {
+  logError('Setup failed: ' + error.message);
+  console.error(error);
+  process.exit(1);
+}