@bubblsdk/react-native-sdk 4.1.7 → 5.0.0-alpha.2

package/src/NativeBubblSdk.ts

@@ -0,0 +1,67 @@
+import type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+/**
+ * The native module under the facade (src/index.ts): the Bubbl SDK on each platform, called with
+ * JSON strings rather than mapped objects (the same convention as the Flutter wrapper), so the
+ * bridge stays small and the native types stay the source of truth.
+ *
+ *  - Messages cross as their contract Notification JSON (BubblMessage.json) going in, and as the
+ *    public message object (fields worked out natively, plus json) coming out.
+ *  - Events and notifications for the app's listener arrive as JSON on one event, "BubblSdkEvent".
+ *
+ * Codegen reads this file (package.json codegenConfig); keep it to the types codegen knows.
+ */
+export interface Spec extends TurboModule {
+  /** Bubbl works on this device (iOS 17+, Android 8.1+); below, every call does nothing. */
+  isSupported(): boolean;
+  start(apiKey: string, optionsJson: string): void;
+  /** The credential as plain strings, never inside JSON: a parse error could echo the secret. */
+  startWithCredential(keyId: string, secret: string, installId: string, optionsJson: string): void;
+  stop(): void;
+
+  setConsent(granted: boolean): void;
+  optOut(): void;
+  deleteMyData(): void;
+  setLocationEnabled(enabled: boolean): void;
+
+  /** BubblPermissionStatus as JSON, or null before start. */
+  permissionStatus(): Promise<string | null>;
+  requestNotifications(): Promise<string | null>;
+  requestLocation(always: boolean): Promise<string | null>;
+  openSettings(): void;
+
+  setSegments(segments: string[]): void;
+  track(name: string, propertiesJson: string): void;
+
+  /** Whether the app has a notification listener (the native side consults it only in the foreground). */
+  setNotificationListenerEnabled(enabled: boolean): void;
+  /**
+   * A "notification.handle" carries a token: JS claims it on arrival (else native shows the
+   * notification after a few seconds), then finishes it once the app's listener has decided
+   * (native shows it unless the app does). Native shows whatever is unsettled when JS goes away.
+   */
+  claimNotification(token: string): void;
+  finishNotification(token: string, appShowsIt: boolean): void;
+  present(messageJson: string): void;
+  reportDisplayed(messageJson: string): void;
+  reportOpened(messageJson: string): void;
+  reportCtaClicked(messageJson: string): void;
+  reportDismissed(messageJson: string): void;
+  reportMediaViewed(messageJson: string): void;
+  reportMediaCompleted(messageJson: string, durationSeconds: number): void;
+  reportSurveyStarted(messageJson: string): void;
+  submitSurvey(messageJson: string, answersJson: string): Promise<boolean>;
+  openCta(messageJson: string): void;
+
+  /** Bubbl.Diagnostics as JSON. */
+  /** BubblTestDeviceResult as JSON: {approved, message}. */
+  registerTestDevice(code: string): Promise<string>;
+  diagnostics(): Promise<string>;
+
+  // NativeEventEmitter's bookkeeping.
+  addListener(eventName: string): void;
+  removeListeners(count: number): void;
+}
+
+export default TurboModuleRegistry.get<Spec>('BubblSdk');