@txlemetry/react-native-plugin 2.5.1

package/src/index.tsx

@@ -0,0 +1,238 @@
+import { NativeEventEmitter, NativeModules, Platform } from 'react-native'
+import type { EmitterSubscription } from 'react-native'
+
+const LINKING_ERROR =
+  `The package '@txlemetry/react-native-plugin' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo Go\n'
+
+const nativeModule = NativeModules.TxlemetryReactNativePlugin || NativeModules.PosthogReactNativePlugin
+  ? NativeModules.TxlemetryReactNativePlugin || NativeModules.PosthogReactNativePlugin
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR)
+        },
+      }
+    )
+
+export type TxlemetryReactNativePluginMap = { [key: string]: any }
+
+export interface TxlemetryReactNativePluginSessionReplayConfig {
+  enabled?: boolean
+  sdkReplayConfig?: TxlemetryReactNativePluginMap
+  decideReplayConfig?: TxlemetryReactNativePluginMap
+}
+
+export interface TxlemetryReactNativePluginExceptionStepsConfig {
+  enabled?: boolean
+  maxBytes?: number
+}
+
+export interface TxlemetryReactNativePluginErrorTrackingConfig {
+  nativeAutocapture?: boolean
+  exceptionSteps?: TxlemetryReactNativePluginExceptionStepsConfig
+}
+
+export interface TxlemetryReactNativePluginPushConfig {
+  capturePushNotificationSubscriptions?: boolean
+  capturePushNotificationOpened?: boolean
+  /**
+   * A provider callback can't cross the bridge, so this only tells native whether to
+   * install the bridging provider at all — installing one the host didn't ask for
+   * would change how the native SDK handles a 401 on the subscription call.
+   * Pair with {@link setPushIdentityProvider} before calling setup().
+   */
+  pushIdentityProviderEnabled?: boolean
+}
+
+export interface TxlemetryReactNativePluginConfig {
+  sessionReplay?: TxlemetryReactNativePluginSessionReplayConfig
+  errorTracking?: TxlemetryReactNativePluginErrorTrackingConfig
+  push?: TxlemetryReactNativePluginPushConfig
+}
+
+export function setup(
+  sessionId: string,
+  sdkOptions: TxlemetryReactNativePluginMap,
+  pluginConfig: TxlemetryReactNativePluginConfig = {}
+): Promise<void> {
+  return nativeModule.setup(sessionId, sdkOptions, pluginConfig)
+}
+
+export function start(
+  sessionId: string,
+  sdkOptions: TxlemetryReactNativePluginMap,
+  sdkReplayConfig: TxlemetryReactNativePluginMap,
+  decideReplayConfig: TxlemetryReactNativePluginMap
+): Promise<void> {
+  return nativeModule.start(sessionId, sdkOptions, sdkReplayConfig, decideReplayConfig)
+}
+
+export function startSession(sessionId: string): Promise<void> {
+  return nativeModule.startSession(sessionId)
+}
+
+export function endSession(): Promise<void> {
+  return nativeModule.endSession()
+}
+
+export function isEnabled(): Promise<boolean> {
+  return nativeModule.isEnabled()
+}
+
+export function identify(distinctId: string, anonymousId: string): Promise<void> {
+  return nativeModule.identify(distinctId, anonymousId)
+}
+
+/**
+ * Resets the native SDK's identity on logout. Unlike {@link identify}, this calls the native
+ * SDK's own `reset()`, which unregisters the logged-out user's push subscription and
+ * re-registers it under the new anonymous id.
+ */
+export function reset(distinctId: string, anonymousId: string): Promise<void> {
+  return nativeModule.reset(distinctId, anonymousId)
+}
+
+export function startRecording(resumeCurrent: boolean): Promise<void> {
+  return nativeModule.startRecording(resumeCurrent)
+}
+
+export function stopRecording(): Promise<void> {
+  return nativeModule.stopRecording()
+}
+
+export function addExceptionStep(message: string, properties?: TxlemetryReactNativePluginMap): Promise<void> {
+  return nativeModule.addExceptionStep(message, properties ?? {})
+}
+
+export function registerPushNotificationToken(deviceToken: string, appId: string | null): Promise<void> {
+  return nativeModule.registerPushNotificationToken(deviceToken, appId)
+}
+
+export function unregisterPushNotificationToken(): Promise<void> {
+  return nativeModule.unregisterPushNotificationToken()
+}
+
+/**
+ * Propagates a runtime consent change to the native SDK, which otherwise only reads the JS
+ * opt-out flag at setup() and could auto-register a refreshed push token after optOut().
+ */
+export function setOptOut(optOut: boolean): Promise<void> {
+  return nativeModule.setOptOut(optOut)
+}
+
+export function capturePushNotificationOpened(properties: TxlemetryReactNativePluginMap): Promise<void> {
+  return nativeModule.capturePushNotificationOpened(properties)
+}
+
+/**
+ * Mints a signed identity-verification token for a push subscription request.
+ * Return null to send the request without an identity token.
+ */
+export type TxlemetryPushIdentityProvider = (distinctId: string, appId: string) => Promise<string | null>
+
+const PUSH_IDENTITY_EVENT = 'PostHogPushIdentityRequest'
+
+let pushIdentitySubscription: EmitterSubscription | undefined
+
+/**
+ * Installs the JS side of the push identity-provider bridge. The native SDK asks for a
+ * token via the native bridge event; the reply is routed back with
+ * `providePushIdentityToken`, keyed by the request id so late replies are ignored.
+ *
+ * Install before setup() with `push.pushIdentityProviderEnabled` set, so the native
+ * config gets its bridging provider at SDK initialization. Any provider failure
+ * degrades to a null token — an unauthenticated request — never a stalled mint.
+ */
+export function setPushIdentityProvider(provider: TxlemetryPushIdentityProvider): void {
+  pushIdentitySubscription?.remove()
+  // Via the proxy, not raw NativeModules: an unlinked module would build an emitter over
+  // undefined and throw a generic RN error inside the SDK's init try, taking replay down with it.
+  const emitter = new NativeEventEmitter(nativeModule)
+  pushIdentitySubscription = emitter.addListener(
+    PUSH_IDENTITY_EVENT,
+    async (request: { requestId: string; distinctId: string; appId: string }) => {
+      let token: string | null = null
+      try {
+        const minted = await provider(request.distinctId, request.appId)
+        token = typeof minted === 'string' ? minted : null
+      } catch (e) {
+        // eslint-disable-next-line no-console
+        console.warn(`[Txlemetry] pushIdentityProvider threw: ${e}. Push subscription will be sent unauthenticated.`)
+      }
+      try {
+        await nativeModule.providePushIdentityToken(request.requestId, token)
+      } catch (e) {
+        // eslint-disable-next-line no-console
+        console.warn(`[Txlemetry] Failed to deliver push identity token to native: ${e}`)
+      }
+    }
+  )
+}
+
+export interface TxlemetryReactNativePluginModule {
+  setup: (
+    sessionId: string,
+    sdkOptions: TxlemetryReactNativePluginMap,
+    pluginConfig?: TxlemetryReactNativePluginConfig
+  ) => Promise<void>
+
+  /**
+   * Legacy session replay setup entrypoint. Prefer setup() for new native features.
+   */
+  start: (
+    sessionId: string,
+    sdkOptions: TxlemetryReactNativePluginMap,
+    sdkReplayConfig: TxlemetryReactNativePluginMap,
+    decideReplayConfig: TxlemetryReactNativePluginMap
+  ) => Promise<void>
+
+  startSession: (sessionId: string) => Promise<void>
+
+  endSession: () => Promise<void>
+
+  isEnabled: () => Promise<boolean>
+
+  identify: (distinctId: string, anonymousId: string) => Promise<void>
+
+  reset: (distinctId: string, anonymousId: string) => Promise<void>
+
+  startRecording: (resumeCurrent: boolean) => Promise<void>
+
+  stopRecording: () => Promise<void>
+
+  addExceptionStep: (message: string, properties?: TxlemetryReactNativePluginMap) => Promise<void>
+
+  registerPushNotificationToken: (deviceToken: string, appId: string | null) => Promise<void>
+
+  unregisterPushNotificationToken: () => Promise<void>
+
+  setOptOut: (optOut: boolean) => Promise<void>
+
+  capturePushNotificationOpened: (properties: TxlemetryReactNativePluginMap) => Promise<void>
+
+  setPushIdentityProvider: (provider: TxlemetryPushIdentityProvider) => void
+}
+
+const TxlemetryReactNativePlugin: TxlemetryReactNativePluginModule = {
+  setup,
+  start,
+  startSession,
+  endSession,
+  isEnabled,
+  identify,
+  reset,
+  startRecording,
+  stopRecording,
+  addExceptionStep,
+  registerPushNotificationToken,
+  unregisterPushNotificationToken,
+  setOptOut,
+  capturePushNotificationOpened,
+  setPushIdentityProvider,
+}
+
+export default TxlemetryReactNativePlugin

package/txlemetry-react-native-plugin.podspec

@@ -0,0 +1,69 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+# Single source of truth for the native dependency version.
+# Used by both the SPM and CocoaPods resolution paths below; bump this
+# line when picking up a new native SDK release.
+posthog_ios_version = '3.69.10'
+
+Pod::Spec.new do |s|
+  s.name         = "txlemetry-react-native-plugin"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported, :osx => '10.15' }
+  s.source       = { :git => "https://github.com/hectorvss/Txlemetry.git", :tag => "@txlemetry/react-native-plugin@#{s.version}" }
+
+  s.source_files = "ios/PosthogReactNativePlugin.{swift,h,hpp,m,mm,c,cpp}"
+
+  # Default: resolve the native SDK via CocoaPods trunk.
+  # Opt-in: set `txlemetry.useSpm` to `"true"` in the consumer's
+  # `ios/Podfile.properties.json` to resolve the native SDK via Swift Package
+  # Manager using the React Native `spm_dependency` helper (RN >= 0.75).
+  # The SPM path requires `use_frameworks! :linkage => :dynamic` in the Podfile.
+  podfile_properties_path = File.join(Pod::Config.instance.installation_root.to_s, 'Podfile.properties.json')
+  podfile_properties = File.exist?(podfile_properties_path) ? (JSON.parse(File.read(podfile_properties_path)) rescue {}) : {}
+  txlemetry_use_spm = podfile_properties['txlemetry.useSpm'].to_s == 'true' || podfile_properties['posthog.useSpm'].to_s == 'true'
+
+  if txlemetry_use_spm && respond_to?(:spm_dependency, true)
+    spm_dependency(s,
+      url: 'https://github.com/PostHog/posthog-ios.git',
+      requirement: { kind: 'upToNextMinorVersion', minimumVersion: posthog_ios_version },
+      products: ['PostHog']
+    )
+  else
+    s.dependency 'PostHog', "~> #{posthog_ios_version}"
+  end
+  s.ios.deployment_target = '13.0'
+  s.osx.deployment_target = '10.15'
+  s.swift_versions = "5.3"
+
+
+  # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
+  # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency "React-Core"
+
+    # Don't install the dependencies when we run `pod install` in the old architecture.
+    if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
+      s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+      s.pod_target_xcconfig    = {
+          "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+          "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
+          "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+      }
+      s.dependency "React-Codegen"
+      s.dependency "RCT-Folly"
+      s.dependency "RCTRequired"
+      s.dependency "RCTTypeSafety"
+      s.dependency "ReactCommon/turbomodule/core"
+    end
+  end
+end