@goliapkg/sentori-expo 5.0.0 → 7.0.0

package/app.plugin.js

@@ -4,36 +4,252 @@
  * `@goliapkg/sentori-react-native` already exposes
  * `expo-module.config.json` + iOS podspec + Android build.gradle, so
  * Expo Modules autolinking handles the native side without any
- * additional config-plugins work. The Config Plugin entry exists
- * mainly as a marker so users can drop:
+ * additional config-plugins work for error / span / replay capture.
  *
- *   {
- *     "expo": {
- *       "plugins": ["@goliapkg/sentori-expo"]
- *     }
- *   }
+ * v2.11 — extends the plugin to also wire **push notifications** for
+ * apps that opt in. When the host adds `@goliapkg/sentori-expo` to
+ * its `app.json` plugins array, prebuild auto-injects:
  *
- * into their app.json without breaking the build, and so we can
- * extend it later (e.g. SDK-version metadata in Info.plist /
- * AndroidManifest, native crash-handler opt-ins) without changing
- * the user-facing wiring.
+ *   iOS:
+ *     - Info.plist: UIBackgroundModes ⊇ [remote-notification]
+ *     - Entitlements: aps-environment = 'production' (Xcode flips to
+ *       'development' for debug signing automatically)
+ *
+ *   Android:
+ *     - AndroidManifest.xml: <uses-permission POST_NOTIFICATIONS>
+ *     - Root build.gradle: classpath com.google.gms:google-services
+ *     - App build.gradle: apply google-services + firebase-bom +
+ *       firebase-messaging
+ *     - Copies google-services.json from `props.googleServicesFile`
+ *       (defaults to `./google-services.json` at the host root) to
+ *       `android/app/google-services.json` on prebuild.
+ *
+ * Opt out per platform with `{ ios: false }` / `{ android: false }`.
+ * Opt out entirely by not including the plugin in `app.json`.
  *
  * The plugin is intentionally CommonJS — Expo's plugin loader uses
  * `require()`.
  */
-const { withInfoPlist } = require('@expo/config-plugins')
+const fs = require('fs')
+const path = require('path')
+const {
+  withInfoPlist,
+  withEntitlementsPlist,
+  withAndroidManifest,
+  withProjectBuildGradle,
+  withAppBuildGradle,
+  withDangerousMod,
+  AndroidConfig,
+  withPlugins,
+} = require('@expo/config-plugins')
 
 const SENTORI_VERSION_KEY = 'SentoriSdkVersion'
+const FIREBASE_BOM_VERSION = '33.5.1'
+const GOOGLE_SERVICES_VERSION = '4.4.2'
+
+// ── Existing marker (Sentori SDK version surface) ──────────────────
 
 /**
  * @param {import('@expo/config-plugins').ExpoConfig} config
- * @param {{ sdkVersion?: string }} [props]
+ * @param {{ sdkVersion?: string }} props
  */
-const withSentori = (config, props = {}) => {
+const withSentoriVersion = (config, props = {}) => {
   return withInfoPlist(config, (cfg) => {
     cfg.modResults[SENTORI_VERSION_KEY] = props.sdkVersion || '0.1.0'
     return cfg
   })
 }
 
+// ── v2.11 iOS push ─────────────────────────────────────────────────
+
+/**
+ * @param {import('@expo/config-plugins').ExpoConfig} config
+ */
+const withSentoriPushIos = (config) => {
+  config = withInfoPlist(config, (cfg) => {
+    const modes = Array.isArray(cfg.modResults.UIBackgroundModes)
+      ? cfg.modResults.UIBackgroundModes
+      : []
+    if (!modes.includes('remote-notification')) {
+      modes.push('remote-notification')
+    }
+    cfg.modResults.UIBackgroundModes = modes
+    return cfg
+  })
+  config = withEntitlementsPlist(config, (cfg) => {
+    if (!cfg.modResults['aps-environment']) {
+      // Xcode automatically swaps to 'development' when the build is
+      // signed with a development provisioning profile, so this
+      // default is correct for both flavors.
+      cfg.modResults['aps-environment'] = 'production'
+    }
+    return cfg
+  })
+  return config
+}
+
+// ── v2.11 Android push ─────────────────────────────────────────────
+
+/**
+ * @param {import('@expo/config-plugins').ExpoConfig} config
+ */
+const withSentoriPushAndroidManifest = (config) => {
+  return withAndroidManifest(config, (cfg) => {
+    const manifest = cfg.modResults.manifest
+    AndroidConfig.Permissions.addPermission(
+      manifest,
+      'android.permission.POST_NOTIFICATIONS'
+    )
+    return cfg
+  })
+}
+
+/**
+ * @param {import('@expo/config-plugins').ExpoConfig} config
+ */
+const withSentoriPushAndroidGradle = (config) => {
+  // Root build.gradle: add google-services classpath.
+  config = withProjectBuildGradle(config, (cfg) => {
+    if (cfg.modResults.language === 'groovy') {
+      const classpath = `classpath('com.google.gms:google-services:${GOOGLE_SERVICES_VERSION}')`
+      if (!cfg.modResults.contents.includes('com.google.gms:google-services')) {
+        cfg.modResults.contents = cfg.modResults.contents.replace(
+          /(dependencies\s*\{)/,
+          `$1\n        ${classpath}`
+        )
+      }
+    }
+    return cfg
+  })
+  // App build.gradle: apply plugin + firebase deps.
+  config = withAppBuildGradle(config, (cfg) => {
+    if (cfg.modResults.language !== 'groovy') return cfg
+    let contents = cfg.modResults.contents
+    if (!contents.includes('com.google.gms.google-services')) {
+      contents += `\napply plugin: 'com.google.gms.google-services'\n`
+    }
+    if (!contents.includes('firebase-bom')) {
+      contents = contents.replace(
+        /(dependencies\s*\{)/,
+        `$1\n    implementation platform('com.google.firebase:firebase-bom:${FIREBASE_BOM_VERSION}')\n    implementation 'com.google.firebase:firebase-messaging'`
+      )
+    }
+    cfg.modResults.contents = contents
+    return cfg
+  })
+  return config
+}
+
+/**
+ * @param {import('@expo/config-plugins').ExpoConfig} config
+ * @param {{ googleServicesFile?: string }} props
+ */
+const withSentoriGoogleServicesJson = (config, props = {}) => {
+  return withDangerousMod(config, [
+    'android',
+    async (cfg) => {
+      const srcRel = props.googleServicesFile || './google-services.json'
+      const projectRoot = cfg.modRequest.projectRoot
+      const src = path.isAbsolute(srcRel) ? srcRel : path.join(projectRoot, srcRel)
+      if (!fs.existsSync(src)) {
+        // Don't fail the build; warn so the operator notices.
+        // eslint-disable-next-line no-console
+        console.warn(
+          `[sentori-expo] google-services.json not found at ${src}; skipping copy. Push will work once the file is added + prebuild re-runs.`
+        )
+        return cfg
+      }
+      const platformRoot = cfg.modRequest.platformProjectRoot
+      const dest = path.join(platformRoot, 'app', 'google-services.json')
+      fs.mkdirSync(path.dirname(dest), { recursive: true })
+      fs.copyFileSync(src, dest)
+      return cfg
+    },
+  ])
+}
+
+// ── v2.28 iOS Notification Service Extension scaffolding ──────────
+//
+// Rich-media notifications (images / future video) require an NSE
+// target on the iOS app. The Sentori NSE template downloads the URL
+// at `userInfo.sentori_attachment_url` and attaches it before iOS
+// displays the notification. APNs server side sets this key when
+// `richMedia.imageUrl` is on the send (v2.28+).
+//
+// v2.28 ships the source files via withDangerousMod. Adding the NSE
+// **target** to the Xcode project is a one-time manual step (5 clicks
+// in Xcode → File → New → Target → Notification Service Extension,
+// then drag in our Swift file). The recipe walks the developer through
+// it. v2.28.1 will auto-inject the target via withXcodeProject.
+//
+// Opt out with `{ ios: false }` (which also drops the rest of the iOS
+// push wiring) or with `{ nse: false }` for just this template.
+
+/**
+ * @param {import('@expo/config-plugins').ExpoConfig} config
+ */
+const withSentoriNSE = (config) => {
+  return withDangerousMod(config, [
+    'ios',
+    async (cfg) => {
+      const platformRoot = cfg.modRequest.platformProjectRoot
+      const destDir = path.join(platformRoot, 'SentoriNSE')
+      const templateDir = path.join(__dirname, 'templates', 'ios-nse')
+      const swiftSrc = path.join(templateDir, 'SentoriNotificationServiceExtension.swift')
+      const plistSrc = path.join(templateDir, 'SentoriNSE-Info.plist')
+      if (!fs.existsSync(swiftSrc) || !fs.existsSync(plistSrc)) {
+        // eslint-disable-next-line no-console
+        console.warn(
+          '[sentori-expo] NSE templates missing; skipping. Reinstall the package to restore.'
+        )
+        return cfg
+      }
+      fs.mkdirSync(destDir, { recursive: true })
+      fs.copyFileSync(
+        swiftSrc,
+        path.join(destDir, 'SentoriNotificationServiceExtension.swift')
+      )
+      fs.copyFileSync(plistSrc, path.join(destDir, 'SentoriNSE-Info.plist'))
+      // One-time guidance for first-time setup. Idempotent — appears
+      // on every prebuild until the target exists.
+      const pbxproj = path.join(platformRoot, cfg.modRequest.projectName + '.xcodeproj', 'project.pbxproj')
+      if (fs.existsSync(pbxproj)) {
+        const proj = fs.readFileSync(pbxproj, 'utf8')
+        if (!proj.includes('SentoriNSE')) {
+          // eslint-disable-next-line no-console
+          console.log(
+            '\n[sentori-expo] iOS NSE template files copied to ios/SentoriNSE/.\n' +
+              '             For rich-media (image) notifications to render, add a\n' +
+              '             Notification Service Extension target via Xcode and link\n' +
+              '             these files. Detailed steps in the recipe.\n'
+          )
+        }
+      }
+      return cfg
+    },
+  ])
+}
+
+// ── Composer ───────────────────────────────────────────────────────
+
+/**
+ * @param {import('@expo/config-plugins').ExpoConfig} config
+ * @param {{ sdkVersion?: string, ios?: boolean, android?: boolean, nse?: boolean, googleServicesFile?: string }} [props]
+ */
+const withSentori = (config, props = {}) => {
+  const plugins = [[withSentoriVersion, props]]
+  if (props.ios !== false) {
+    plugins.push([withSentoriPushIos, props])
+    if (props.nse !== false) plugins.push([withSentoriNSE, props])
+  }
+  if (props.android !== false) {
+    plugins.push(
+      [withSentoriPushAndroidManifest, props],
+      [withSentoriPushAndroidGradle, props],
+      [withSentoriGoogleServicesJson, props]
+    )
+  }
+  return withPlugins(config, plugins)
+}
+
 module.exports = withSentori

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goliapkg/sentori-expo",
-  "version": "5.0.0",
+  "version": "7.0.0",
   "description": "Expo adapter for Sentori — Config Plugin marker, expo-application auto-config, EAS post-build helper. Built on @goliapkg/sentori-react-native.",
   "license": "Apache-2.0 OR MIT",
   "author": "GOLIA K.K. <takagi@golia.jp> (https://golia.jp)",
@@ -36,6 +36,7 @@
     "src/",
     "app.plugin.js",
     "scripts/",
+    "templates/",
     "README.md"
   ],
   "scripts": {
@@ -45,10 +46,10 @@
     "prepack": "bun run build"
   },
   "peerDependencies": {
-    "@goliapkg/sentori-react-native": ">=2.2.0",
-    "expo": ">=50",
-    "expo-application": ">=5",
-    "react-native": ">=0.74"
+    "@goliapkg/sentori-react-native": ">=3.1.0",
+    "expo": ">=55.0.0 <57.0.0",
+    "expo-application": ">=55.0.0 <57.0.0",
+    "react-native": ">=0.81.0"
   },
   "peerDependenciesMeta": {
     "expo-application": {
@@ -56,7 +57,7 @@
     }
   },
   "dependencies": {
-    "@expo/config-plugins": "^9 || ^10"
+    "@expo/config-plugins": ">=55.0.0 <57.0.0"
   },
   "devDependencies": {
     "@goliapkg/sentori-react-native": "workspace:*",

package/templates/ios-nse/SentoriNSE-Info.plist

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>CFBundleDevelopmentRegion</key>
+    <string>$(DEVELOPMENT_LANGUAGE)</string>
+    <key>CFBundleDisplayName</key>
+    <string>SentoriNSE</string>
+    <key>CFBundleExecutable</key>
+    <string>$(EXECUTABLE_NAME)</string>
+    <key>CFBundleIdentifier</key>
+    <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleName</key>
+    <string>$(PRODUCT_NAME)</string>
+    <key>CFBundlePackageType</key>
+    <string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+    <key>CFBundleShortVersionString</key>
+    <string>1.0</string>
+    <key>CFBundleVersion</key>
+    <string>1</string>
+    <key>NSExtension</key>
+    <dict>
+        <key>NSExtensionPointIdentifier</key>
+        <string>com.apple.usernotifications.service</string>
+        <key>NSExtensionPrincipalClass</key>
+        <string>$(PRODUCT_MODULE_NAME).SentoriNotificationServiceExtension</string>
+    </dict>
+</dict>
+</plist>

package/templates/ios-nse/SentoriNotificationServiceExtension.swift

@@ -0,0 +1,77 @@
+// Sentori Notification Service Extension — v2.28.
+//
+// When an APNs payload arrives with `mutable-content: 1` AND a custom
+// `sentori_attachment_url` field, this extension downloads the image
+// and attaches it to the notification before iOS displays it.
+//
+// Lifecycle:
+//   - serviceExtensionTimeWillExpire is called ~30 s after delivery.
+//     We fall back to the unaltered notification at that point.
+//   - All work runs off the main thread; the OS gives this extension
+//     up to ~30 s with a hard CPU budget. The download is on a
+//     background URLSession with 5 s timeout so a slow CDN does not
+//     burn the budget.
+//
+// This file is written by `@goliapkg/sentori-expo` v2.28+'s
+// `withSentoriNSE` config plugin into `ios/SentoriNSE/` on every
+// `expo prebuild`. The one-time Xcode target wiring is documented in
+// the recipe (auto-injection lands in v2.28.1).
+
+import UserNotifications
+
+final class SentoriNotificationServiceExtension: UNNotificationServiceExtension {
+    private var contentHandler: ((UNNotificationContent) -> Void)?
+    private var bestAttempt: UNMutableNotificationContent?
+
+    override func didReceive(
+        _ request: UNNotificationRequest,
+        withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
+    ) {
+        self.contentHandler = contentHandler
+        self.bestAttempt = (request.content.mutableCopy() as? UNMutableNotificationContent)
+        guard let bestAttempt = self.bestAttempt else {
+            contentHandler(request.content)
+            return
+        }
+
+        // Extract the Sentori-reserved attachment URL. v2.28 server
+        // emits this as a top-level custom-data key when the send's
+        // `richMedia.imageUrl` is set.
+        guard
+            let raw = bestAttempt.userInfo["sentori_attachment_url"] as? String,
+            let url = URL(string: raw)
+        else {
+            contentHandler(bestAttempt)
+            return
+        }
+
+        // Bounded-time download to a temp file. URLSession.shared
+        // honours the request's timeout; we set it to 5 s so a stalled
+        // CDN does not eat the ~30 s extension budget.
+        var request = URLRequest(url: url)
+        request.timeoutInterval = 5
+        let task = URLSession.shared.downloadTask(with: request) { tempURL, _, _ in
+            defer { contentHandler(bestAttempt) }
+            guard let tempURL = tempURL else { return }
+            // Move to a guessed-extension destination so iOS picks a
+            // sensible content type.
+            let ext = url.pathExtension.isEmpty ? "img" : url.pathExtension
+            let dest = tempURL.deletingPathExtension().appendingPathExtension(ext)
+            try? FileManager.default.moveItem(at: tempURL, to: dest)
+            if let attachment = try? UNNotificationAttachment(
+                identifier: "sentori-image",
+                url: dest,
+                options: nil
+            ) {
+                bestAttempt.attachments = [attachment]
+            }
+        }
+        task.resume()
+    }
+
+    override func serviceExtensionTimeWillExpire() {
+        if let contentHandler = contentHandler, let bestAttempt = bestAttempt {
+            contentHandler(bestAttempt)
+        }
+    }
+}