@tryheliumai/paywall-sdk-react-native 3.0.6 → 3.0.12

package/src/native-interface.tsx

@@ -12,6 +12,7 @@ import type {
   PaywallEventHandlers,
   HeliumPaywallEvent,
 } from './types';
+import type { ExperimentInfo } from './HeliumExperimentInfo.types';
 
 const { HeliumBridge } = NativeModules;
 const heliumEventEmitter = new NativeEventEmitter(HeliumBridge);
@@ -162,34 +163,20 @@ export const presentUpsell = ({
   eventHandlers,
   customPaywallTraits,
 }: PresentUpsellParams) => {
-  HeliumBridge.canPresentUpsell(
-    triggerName,
-    (canPresent: boolean, reason: string) => {
-      if (!canPresent) {
-        console.log(
-          `[Helium] Cannot present trigger "${triggerName}". Reason: ${reason}`
-        );
-        onFallback?.();
-        HeliumBridge.fallbackOpenOrCloseEvent(triggerName, true, 'presented');
-        return;
-      }
-
-      try {
-        paywallEventHandlers = eventHandlers;
-        presentOnFallback = onFallback;
-        HeliumBridge.presentUpsell(
-          triggerName,
-          convertBooleansToMarkers(customPaywallTraits) || null
-        );
-      } catch (error) {
-        console.log('[Helium] Present error', error);
-        paywallEventHandlers = undefined;
-        presentOnFallback = undefined;
-        onFallback?.();
-        HeliumBridge.fallbackOpenOrCloseEvent(triggerName, true, 'presented');
-      }
-    }
-  );
+  try {
+    paywallEventHandlers = eventHandlers;
+    presentOnFallback = onFallback;
+    HeliumBridge.presentUpsell(
+      triggerName,
+      convertBooleansToMarkers(customPaywallTraits) || null
+    );
+  } catch (error) {
+    console.log('[Helium] presentUpsell error', error);
+    paywallEventHandlers = undefined;
+    presentOnFallback = undefined;
+    onFallback?.();
+    HeliumBridge.fallbackOpenOrCloseEvent(triggerName, true, 'presented');
+  }
 };
 
 function callPaywallEventHandlers(event: HeliumPaywallEvent) {
@@ -229,6 +216,26 @@ function callPaywallEventHandlers(event: HeliumPaywallEvent) {
           isSecondTry: event.isSecondTry ?? false,
         });
         break;
+      case 'paywallOpenFailed':
+        paywallEventHandlers?.onOpenFailed?.({
+          type: 'paywallOpenFailed',
+          triggerName: event.triggerName ?? 'unknown',
+          paywallName: event.paywallName ?? 'unknown',
+          error: event.error ?? 'Unknown error',
+          paywallUnavailableReason: event.paywallUnavailableReason,
+          isSecondTry: event.isSecondTry ?? false,
+        });
+        break;
+      case 'customPaywallAction':
+        paywallEventHandlers?.onCustomPaywallAction?.({
+          type: 'customPaywallAction',
+          triggerName: event.triggerName ?? 'unknown',
+          paywallName: event.paywallName ?? 'unknown',
+          actionName: event.customPaywallActionName ?? 'unknown',
+          params: event.customPaywallActionParams ?? {},
+          isSecondTry: event.isSecondTry ?? false,
+        });
+        break;
     }
   }
 }
@@ -247,7 +254,15 @@ function handlePaywallEvent(event: HeliumPaywallEvent) {
       break;
     case 'paywallOpenFailed':
       paywallEventHandlers = undefined;
-      presentOnFallback?.();
+      const unavailableReason = event.paywallUnavailableReason;
+      if (
+        event.triggerName &&
+        unavailableReason !== 'alreadyPresented' &&
+        unavailableReason !== 'secondTryNoMatch'
+      ) {
+        console.log('[Helium] paywall open failed', unavailableReason);
+        presentOnFallback?.();
+      }
       presentOnFallback = undefined;
       break;
   }
@@ -313,6 +328,57 @@ export const hasAnyEntitlement = async (): Promise<boolean> => {
   return HeliumBridge.hasAnyEntitlement();
 };
 
+/**
+ * Get experiment allocation info for a specific trigger
+ *
+ * @param trigger The trigger name to get experiment info for
+ * @returns ExperimentInfo if the trigger has experiment data, undefined otherwise
+ */
+export const getExperimentInfoForTrigger = async (
+  trigger: string
+): Promise<ExperimentInfo | undefined> => {
+  return new Promise((resolve) => {
+    HeliumBridge.getExperimentInfoForTrigger(trigger, (success: boolean, data: any) => {
+      if (!success) {
+        resolve(undefined);
+        return;
+      }
+      resolve(data as ExperimentInfo);
+    });
+  });
+};
+
+/**
+ * Reset Helium entirely so you can call initialize again. Only for advanced use cases.
+ */
+export const resetHelium = () => {
+  HeliumBridge.resetHelium();
+};
+
+/**
+ * Set custom strings to show in the dialog that Helium will display if a "Restore Purchases" action is not successful.
+ * Note that these strings will not be localized by Helium for you.
+ */
+export const setCustomRestoreFailedStrings = (
+  customTitle?: string,
+  customMessage?: string,
+  customCloseButtonText?: string
+) => {
+  HeliumBridge.setCustomRestoreFailedStrings(
+    customTitle,
+    customMessage,
+    customCloseButtonText
+  );
+};
+
+/**
+ * Disable the default dialog that Helium will display if a "Restore Purchases" action is not successful.
+ * You can handle this yourself if desired by listening for the PurchaseRestoreFailedEvent.
+ */
+export const disableRestoreFailedDialog = () => {
+  HeliumBridge.disableRestoreFailedDialog();
+};
+
 export const HELIUM_CTA_NAMES = {
   SCHEDULE_CALL: 'schedule_call',
   SUBSCRIBE_BUTTON: 'subscribe_button',

package/src/types.ts

@@ -69,6 +69,8 @@ export interface PaywallEventHandlers {
   onClose?: (event: PaywallCloseEvent) => void;
   onDismissed?: (event: PaywallDismissedEvent) => void;
   onPurchaseSucceeded?: (event: PurchaseSucceededEvent) => void;
+  onOpenFailed?: (event: PaywallOpenFailedEvent) => void;
+  onCustomPaywallAction?: (event: CustomPaywallActionEvent) => void;
 }
 
 // Typed event interfaces
@@ -102,6 +104,24 @@ export interface PurchaseSucceededEvent {
   isSecondTry: boolean;
 }
 
+export interface PaywallOpenFailedEvent {
+  type: 'paywallOpenFailed';
+  triggerName: string;
+  paywallName: string;
+  error: string;
+  paywallUnavailableReason?: string;
+  isSecondTry: boolean;
+}
+
+export interface CustomPaywallActionEvent {
+  type: 'customPaywallAction';
+  triggerName: string;
+  paywallName: string;
+  actionName: string;
+  params: Record<string, any>;
+  isSecondTry: boolean;
+}
+
 export type HeliumPaywallEvent = {
   type:
     | 'paywallOpen'
@@ -121,7 +141,9 @@ export type HeliumPaywallEvent = {
     | 'initializeStart'
     | 'paywallsDownloadSuccess'
     | 'paywallsDownloadError'
-    | 'paywallWebViewRendered';
+    | 'paywallWebViewRendered'
+    | 'customPaywallAction'
+    | 'userAllocated';
   triggerName?: string;
   paywallName?: string;
   /**
@@ -155,6 +177,9 @@ export type HeliumPaywallEvent = {
    * Unix timestamp in seconds
    */
   timestamp?: number;
+  paywallUnavailableReason?: string;
+  customPaywallActionName?: string;
+  customPaywallActionParams?: Record<string, any>;
 };
 
 export type PresentUpsellParams = {
@@ -169,7 +194,10 @@ export type PresentUpsellParams = {
 export interface HeliumConfig {
   /** Your Helium API Key */
   apiKey: string;
-  /** Configuration for handling purchases. Can be custom functions or a pre-built handler config. */
+  /**
+   * Configuration for handling purchases. Can be custom functions or a pre-built handler config.
+   * If not provided, Helium will handle purchases for you.
+   */
   purchaseConfig?: HeliumPurchaseConfig;
   /** Callback for receiving all Helium paywall events. */
   onHeliumPaywallEvent: (event: HeliumPaywallEvent) => void;