react-native-acoustic-connect-beta 18.0.36 → 18.0.38

package/cli/ios/setup-push.mjs

@@ -0,0 +1,196 @@
+// `acoustic-connect setup-ios-push [dir]` — create/repair the iOS push extensions.
+//
+// The manual-setup counterpart to what the Expo Config Plugin does on
+// `prebuild`: it provisions the two app-extension targets a bare React Native
+// app needs for Acoustic Connect rich push —
+//
+//   * ConnectNSE — Notification Service Extension
+//   * ConnectNCE — Notification Content Extension
+//
+// Division of labour:
+//   - THIS script (Node) owns the files: it writes the per-extension Swift,
+//     Info.plist and entitlements from the SDK templates (substituting the App
+//     Group from ConnectConfig.json), and ensures the host app has an
+//     entitlements file with aps-environment + the App Group.
+//   - add_push_extensions.rb (Ruby + xcodeproj) owns the pbxproj surgery:
+//     it creates/links the targets, the embed phase, and the system frameworks.
+//
+// Everything is idempotent — existing files are left untouched, existing
+// targets are skipped. Re-running repairs missing pieces without duplicating.
+
+import fs from 'node:fs'
+import path from 'node:path'
+import {fileURLToPath} from 'node:url'
+
+import {color, commandExists, fileExists, readJson, readText, run, section} from '../lib.mjs'
+
+const cliDir = path.dirname(path.dirname(fileURLToPath(import.meta.url))) // .../cli
+const sdkRoot = path.dirname(cliDir) // package root
+const templatesDir = path.join(cliDir, 'ios', 'templates')
+// Swift principal-class templates are shared with the Expo Config Plugin.
+const swiftDir = path.join(sdkRoot, 'plugin', 'swift')
+
+const APP_GROUP_TOKEN = 'CONNECT_APP_GROUP_IDENTIFIER_PLACEHOLDER'
+
+const EXTENSIONS = [
+  {name: 'ConnectNSE', swift: 'NotificationService.swift'},
+  {name: 'ConnectNCE', swift: 'NotificationViewController.swift'},
+]
+
+// Find the single .xcodeproj under <dir>/ios. The app target name follows the
+// RN convention (the project basename), which is what `setup-ios-push` assumes.
+function findXcodeproj(iosDir) {
+  let entries = []
+  try {
+    entries = fs.readdirSync(iosDir)
+  } catch {
+    return null
+  }
+  const proj = entries.find((e) => e.endsWith('.xcodeproj'))
+  return proj ? path.join(iosDir, proj) : null
+}
+
+// Write `content` to `dest` only if missing; report which happened.
+function writeIfMissing(reporter, label, dest, content) {
+  if (fileExists(dest)) {
+    reporter.pass(label, 'present')
+    return
+  }
+  fs.mkdirSync(path.dirname(dest), {recursive: true})
+  fs.writeFileSync(dest, content)
+  reporter.pass(label, 'created')
+}
+
+// Render a template file, substituting the App Group placeholder. Only the
+// real occurrences are replaced — the Swift string literal and the plist
+// <string> entry — so any explanatory comment that mentions the token by name
+// (e.g. "The <token> is replaced by …") stays readable.
+function renderTemplate(srcPath, appGroup) {
+  const raw = readText(srcPath)
+  if (raw == null) return null
+  return raw
+    .split(`"${APP_GROUP_TOKEN}"`)
+    .join(`"${appGroup}"`)
+    .split(`<string>${APP_GROUP_TOKEN}</string>`)
+    .join(`<string>${appGroup}</string>`)
+}
+
+// Minimal host entitlements when the app has none yet: aps-environment +
+// the App Group, matching what the extensions share.
+function hostEntitlements(appGroup) {
+  return `<?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>
+\t<key>aps-environment</key>
+\t<string>development</string>
+\t<key>com.apple.security.application-groups</key>
+\t<array>
+\t\t<string>${appGroup}</string>
+\t</array>
+</dict>
+</plist>
+`
+}
+
+export async function setupIosPush(dir, {reporter}) {
+  console.log(
+    color.bold('\nAcoustic Connect — iOS push extensions') +
+      color.dim(`  (${dir})`),
+  )
+
+  if (process.platform !== 'darwin') {
+    reporter.warn('iOS', 'skipped — iOS project surgery requires macOS')
+    return
+  }
+
+  const iosDir = path.join(dir, 'ios')
+  if (!fileExists(iosDir)) {
+    reporter.fail('ios/', `no ios/ directory under ${dir}`)
+    return
+  }
+
+  const projectPath = findXcodeproj(iosDir)
+  if (!projectPath) {
+    reporter.fail('.xcodeproj', `none found under ${iosDir}`)
+    return
+  }
+  const appTarget = path.basename(projectPath, '.xcodeproj')
+  reporter.pass('Xcode project', `${path.basename(projectPath)} (target ${appTarget})`)
+
+  // App Group is the linchpin — host + both extensions must share it.
+  const cfg = readJson(path.join(dir, 'ConnectConfig.json'))
+  const appGroup = cfg?.Connect?.iOSAppGroupIdentifier
+  if (!appGroup) {
+    reporter.fail(
+      'iOSAppGroupIdentifier',
+      'not set in ConnectConfig.json — required for the NSE/NCE shared store. Run `acoustic-connect doctor` first.',
+    )
+    return
+  }
+  reporter.pass('App Group', appGroup)
+
+  // ── Files (idempotent) ───────────────────────────────────────────────────
+  section('Source files')
+
+  // Host entitlements — only created if absent (never clobber a real one).
+  const hostEntPath = path.join(iosDir, appTarget, `${appTarget}.entitlements`)
+  writeIfMissing(
+    reporter,
+    `${appTarget}/${appTarget}.entitlements`,
+    hostEntPath,
+    hostEntitlements(appGroup),
+  )
+
+  for (const ext of EXTENSIONS) {
+    const extDir = path.join(iosDir, ext.name)
+
+    const swift = renderTemplate(path.join(swiftDir, ext.swift), appGroup)
+    if (swift == null) {
+      reporter.fail(`${ext.name}/${ext.swift}`, `template missing in ${swiftDir}`)
+      return
+    }
+    writeIfMissing(reporter, `${ext.name}/${ext.swift}`, path.join(extDir, ext.swift), swift)
+
+    const tplKey = ext.name === 'ConnectNSE' ? 'nse' : 'nce'
+    const plist = readText(path.join(templatesDir, tplKey, 'Info.plist'))
+    writeIfMissing(reporter, `${ext.name}/Info.plist`, path.join(extDir, 'Info.plist'), plist)
+
+    const ent = renderTemplate(
+      path.join(templatesDir, tplKey, `${ext.name}.entitlements`),
+      appGroup,
+    )
+    writeIfMissing(
+      reporter,
+      `${ext.name}/${ext.name}.entitlements`,
+      path.join(extDir, `${ext.name}.entitlements`),
+      ent,
+    )
+  }
+
+  // ── pbxproj surgery (Ruby) ─────────────────────────────────────────────────
+  section('Xcode targets')
+  if (!commandExists('ruby')) {
+    reporter.warn(
+      'Push extensions',
+      'ruby not found — files written, but run add_push_extensions.rb on a machine with ruby + the xcodeproj gem to wire the targets',
+    )
+    return
+  }
+
+  const rubyScript = path.join(cliDir, 'ios', 'add_push_extensions.rb')
+  // Pass the project path / target name as real environment variables (the
+  // Ruby script reads them via ENV[…]) rather than interpolating them into the
+  // command line — a path with shell metacharacters must not be re-parsed.
+  const rubyEnv = {
+    ACOUSTIC_PROJECT_PATH: projectPath,
+    ACOUSTIC_APP_TARGET: appTarget,
+  }
+  if (run(`ruby "${rubyScript}"`, {cwd: iosDir, env: rubyEnv}))
+    reporter.pass('Push extensions wired (NSE + NCE)')
+  else
+    reporter.fail(
+      'Push extensions',
+      'add_push_extensions.rb failed — needs the xcodeproj gem (ships with CocoaPods: `gem install xcodeproj`)',
+    )
+}

package/cli/ios/templates/nce/ConnectNCE.entitlements

@@ -0,0 +1,10 @@
+<?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>com.apple.security.application-groups</key>
+	<array>
+		<string>CONNECT_APP_GROUP_IDENTIFIER_PLACEHOLDER</string>
+	</array>
+</dict>
+</plist>

package/cli/ios/templates/nce/Info.plist

@@ -0,0 +1,45 @@
+<?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>ConnectNCE</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>$(MARKETING_VERSION)</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionAttributes</key>
+		<dict>
+			<key>UNNotificationExtensionCategory</key>
+			<array>
+				<string>ACOUSTIC_RICH_NOTIFICATION</string>
+				<string>ACTIONABLE_NOTIFICATION</string>
+			</array>
+			<key>UNNotificationExtensionDefaultContentHidden</key>
+			<false/>
+			<key>UNNotificationExtensionInitialContentSizeRatio</key>
+			<real>1.0</real>
+		</dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.usernotifications.content-extension</string>
+		<key>NSExtensionPrincipalClass</key>
+		<string>$(PRODUCT_MODULE_NAME).NotificationViewController</string>
+	</dict>
+	<key>RCTNewArchEnabled</key>
+	<true/>
+</dict>
+</plist>

package/cli/ios/templates/nse/ConnectNSE.entitlements

@@ -0,0 +1,10 @@
+<?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>com.apple.security.application-groups</key>
+	<array>
+		<string>CONNECT_APP_GROUP_IDENTIFIER_PLACEHOLDER</string>
+	</array>
+</dict>
+</plist>

package/cli/ios/templates/nse/Info.plist

@@ -0,0 +1,33 @@
+<?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>ConnectNSE</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>$(MARKETING_VERSION)</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.usernotifications.service</string>
+		<key>NSExtensionPrincipalClass</key>
+		<string>$(PRODUCT_MODULE_NAME).NotificationService</string>
+	</dict>
+	<key>RCTNewArchEnabled</key>
+	<true/>
+</dict>
+</plist>

package/cli/lib.mjs

@@ -0,0 +1,240 @@
+// Shared helpers for the Acoustic Connect SDK setup CLI (`acoustic-connect`).
+//
+// This is the single source of truth that used to be duplicated across the
+// Examples/expo and Examples/bare-workflow `scripts/lib.mjs` files. It ships in
+// the published SDK package so client apps (and our own samples) can run the
+// same doctor / scaffolding without copying it.
+//
+// Cross-platform (macOS / Linux / Windows): only node: built-ins, commands run
+// through the platform shell. iOS-only commands (pod/bundle/ruby) are guarded
+// by the callers, never run on Windows.
+
+import {spawnSync} from 'node:child_process'
+import fs from 'node:fs'
+import path from 'node:path'
+
+const isWindows = process.platform === 'win32'
+const useColor = process.stdout.isTTY && !process.env.NO_COLOR
+
+const paint = (code, s) => (useColor ? `[${code}m${s}` : s)
+export const color = {
+  bold: (s) => paint('1', s),
+  dim: (s) => paint('2', s),
+  red: (s) => paint('31', s),
+  green: (s) => paint('32', s),
+  yellow: (s) => paint('33', s),
+  cyan: (s) => paint('36', s),
+}
+
+export function section(title) {
+  console.log('\n' + color.bold(color.cyan(`▸ ${title}`)))
+}
+
+export function info(msg) {
+  console.log(`  ${msg}`)
+}
+
+// Run a shell command, streaming its output. Returns true on exit code 0.
+// `command` is a full command line (shell-interpreted) so callers can write it
+// the way they'd type it. Pass dynamic, path-derived values through `env`
+// (merged over the parent environment) rather than interpolating them into
+// `command` — that keeps a value containing shell metacharacters (`$`,
+// backticks, quotes, spaces) from being re-parsed by the shell.
+export function run(command, {cwd, env} = {}) {
+  return (
+    spawnSync(command, {
+      cwd,
+      env: {...process.env, ...env},
+      stdio: 'inherit',
+      shell: true,
+    }).status === 0
+  )
+}
+
+// Run a command and capture stdout/stderr instead of streaming. Used for quick
+// version/state probes — never throws (spawnSync returns on a missing binary
+// rather than throwing), and is bounded by `timeout` (default 60s) so an
+// unresponsive probe — e.g. `adb shell` against an offline device — can't hang
+// the caller. On timeout the child is killed and `ok` is false.
+export function capture(command, {cwd, timeout = 60000} = {}) {
+  const result = spawnSync(command, {
+    cwd,
+    encoding: 'utf8',
+    shell: true,
+    timeout,
+    killSignal: 'SIGKILL',
+  })
+  return {
+    ok: result.status === 0,
+    stdout: result.stdout || '',
+    stderr: result.stderr || '',
+  }
+}
+
+// Is a binary resolvable on PATH? Uses `where` on Windows, `command -v` elsewhere.
+export function commandExists(cmd) {
+  const probe = isWindows ? `where ${cmd}` : `command -v ${cmd}`
+  return spawnSync(probe, {stdio: 'ignore', shell: true}).status === 0
+}
+
+export function fileExists(p) {
+  try {
+    return fs.existsSync(p)
+  } catch {
+    return false
+  }
+}
+
+export function readText(p) {
+  try {
+    return fs.readFileSync(p, 'utf8')
+  } catch {
+    return null
+  }
+}
+
+// Read + parse JSON. Returns the parsed value, or `undefined` for any
+// "no usable object" outcome — missing, unreadable, or malformed — so callers
+// only need a single `=== undefined` check and can never hit a TypeError on a
+// null result. Callers that must distinguish missing from malformed should call
+// fileExists() first.
+export function readJson(p) {
+  const raw = readText(p)
+  if (raw == null) return undefined
+  try {
+    return JSON.parse(raw)
+  } catch {
+    return undefined
+  }
+}
+
+// Copy `src` to `dest` only when `dest` is missing. Returns 'created' |
+// 'exists' | 'no-template'. Callers surface the result so the developer knows
+// to fill the freshly-copied file in.
+export function copyIfMissing(src, dest) {
+  if (fileExists(dest)) return 'exists'
+  if (!fileExists(src)) return 'no-template'
+  fs.mkdirSync(path.dirname(dest), {recursive: true})
+  fs.copyFileSync(src, dest)
+  return 'created'
+}
+
+// Walk up from `startDir` for the nearest package.json declaring a `workspaces`
+// array that actually includes `startDir` — that's where `npm install` must run
+// so the SDK is hoisted/symlinked. Returns null for a standalone (published)
+// checkout with no workspace.
+//
+// Only a workspace that actually declares THIS app as a member counts — we
+// verify `target` matches one of the candidate's `workspaces` globs. That way
+// an unrelated outer workspace (e.g. a CI tool's own monorepo root that happens
+// to sit above the checkout) is skipped rather than mistaken for our root.
+export function findWorkspaceRoot(startDir) {
+  const target = path.resolve(startDir)
+  let dir = target
+  for (;;) {
+    const pkgPath = path.join(dir, 'package.json')
+    if (fileExists(pkgPath)) {
+      try {
+        const pkg = JSON.parse(readText(pkgPath))
+        if (pkg && pkg.workspaces && workspaceIncludes(dir, pkg.workspaces, target))
+          return dir
+      } catch {
+        // ignore malformed package.json and keep walking up
+      }
+    }
+    const parent = path.dirname(dir)
+    if (parent === dir) return null
+    dir = parent
+  }
+}
+
+// Does `rootDir`'s `workspaces` declaration cover `target`? Handles the array
+// form and the { packages: [...] } object form, with npm's glob semantics
+// (`*` within a path segment, `**` across segments).
+function workspaceIncludes(rootDir, workspaces, target) {
+  const globs = Array.isArray(workspaces)
+    ? workspaces
+    : Array.isArray(workspaces.packages)
+      ? workspaces.packages
+      : []
+  if (rootDir === target) return true // the workspace root itself
+  const rel = path.relative(rootDir, target).split(path.sep).join('/')
+  return globs.some((glob) => {
+    const pattern = String(glob).replace(/\/$/, '')
+    const re = new RegExp(
+      '^' +
+        pattern
+          .replace(/[.+^${}()|[\]\\]/g, '\\$&') // escape regex specials (keep * /)
+          .replace(/\*\*?/g, (m) => (m === '**' ? '.*' : '[^/]*')) + // ** -> .* , * -> one path segment
+        '$',
+    )
+    return re.test(rel)
+  })
+}
+
+// Accumulates pass/warn/fail results and prints a final summary. A single
+// `fail` makes the process exit non-zero so CI / the developer notice.
+export class Reporter {
+  constructor() {
+    this.results = []
+  }
+
+  record(status, label, detail) {
+    this.results.push({status, label, detail})
+    const mark =
+      status === 'pass'
+        ? color.green('✓')
+        : status === 'warn'
+          ? color.yellow('⚠')
+          : color.red('✗')
+    const tail = detail ? ` ${color.dim('— ' + detail)}` : ''
+    console.log(`  ${mark} ${label}${tail}`)
+  }
+
+  pass(label, detail) {
+    this.record('pass', label, detail)
+  }
+
+  warn(label, detail) {
+    this.record('warn', label, detail)
+  }
+
+  fail(label, detail) {
+    this.record('fail', label, detail)
+  }
+
+  hasFailures() {
+    return this.results.some((r) => r.status === 'fail')
+  }
+
+  // Print the summary and any actionable next steps, then return the exit code.
+  summary(nextSteps = []) {
+    const counts = {pass: 0, warn: 0, fail: 0}
+    for (const r of this.results) counts[r.status]++
+
+    section('Summary')
+    info(
+      `${color.green(counts.pass + ' ok')}, ` +
+        `${color.yellow(counts.warn + ' warning(s)')}, ` +
+        `${color.red(counts.fail + ' failure(s)')}`,
+    )
+
+    const actionable = this.results.filter(
+      (r) => r.status !== 'pass' && r.detail,
+    )
+    if (actionable.length) {
+      section('Action needed')
+      for (const r of actionable) {
+        const mark = r.status === 'fail' ? color.red('✗') : color.yellow('⚠')
+        info(`${mark} ${r.label}: ${r.detail}`)
+      }
+    }
+
+    if (nextSteps.length) {
+      section('Next steps')
+      for (const s of nextSteps) info(`• ${s}`)
+    }
+
+    return this.hasFailures() ? 1 : 0
+  }
+}