@qonversion/react-native-sdk 10.0.1 → 10.1.0

package/src/dto/PurchaseDelegate.ts

@@ -0,0 +1,21 @@
+import Product from './Product';
+
+/**
+ * Delegate responsible for custom purchase and restore handling.
+ * When this delegate is provided, it replaces the default Qonversion SDK purchase flow.
+ */
+export interface PurchaseDelegate {
+  /**
+   * Handle purchase for the given product.
+   * @param product Product to purchase.
+   * @returns Promise that completes successfully when purchase finishes, otherwise throws an error.
+   */
+  purchase(product: Product): Promise<void>;
+
+  /**
+   * Handle restore flow.
+   * @returns Promise that completes successfully when restore finishes, otherwise throws an error.
+   */
+  restore(): Promise<void>;
+}
+

package/src/dto/PurchaseResult.ts

@@ -0,0 +1,88 @@
+import Entitlement from './Entitlement';
+import QonversionError from './QonversionError';
+import StoreTransaction from './StoreTransaction';
+import { PurchaseResultStatus, PurchaseResultSource } from './enums';
+
+/**
+ * Represents the result of a purchase operation.
+ * Contains the status of the purchase, entitlements, and store transaction details.
+ */
+class PurchaseResult {
+  /**
+   * The status of the purchase operation.
+   */
+  status: PurchaseResultStatus;
+
+  /**
+   * The user's entitlements after the purchase.
+   * May be null if the purchase failed or is pending.
+   */
+  entitlements: Map<string, Entitlement> | null;
+
+  /**
+   * The error that occurred during the purchase, if any.
+   */
+  error: QonversionError | null;
+
+  /**
+   * Indicates whether the entitlements were generated from a fallback source.
+   */
+  isFallbackGenerated: boolean;
+
+  /**
+   * The source of the purchase result data.
+   */
+  source: PurchaseResultSource;
+
+  /**
+   * The store transaction details from the native platform.
+   * Contains raw transaction information from Apple App Store or Google Play Store.
+   */
+  storeTransaction: StoreTransaction | null;
+
+  constructor(
+    status: PurchaseResultStatus,
+    entitlements: Map<string, Entitlement> | null,
+    error: QonversionError | null,
+    isFallbackGenerated: boolean,
+    source: PurchaseResultSource,
+    storeTransaction: StoreTransaction | null,
+  ) {
+    this.status = status;
+    this.entitlements = entitlements;
+    this.error = error;
+    this.isFallbackGenerated = isFallbackGenerated;
+    this.source = source;
+    this.storeTransaction = storeTransaction;
+  }
+
+  /**
+   * Returns true if the purchase was successful.
+   */
+  get isSuccess(): boolean {
+    return this.status === PurchaseResultStatus.SUCCESS;
+  }
+
+  /**
+   * Returns true if the purchase was canceled by the user.
+   */
+  get isCanceled(): boolean {
+    return this.status === PurchaseResultStatus.USER_CANCELED;
+  }
+
+  /**
+   * Returns true if the purchase is pending.
+   */
+  get isPending(): boolean {
+    return this.status === PurchaseResultStatus.PENDING;
+  }
+
+  /**
+   * Returns true if an error occurred during the purchase.
+   */
+  get isError(): boolean {
+    return this.status === PurchaseResultStatus.ERROR;
+  }
+}
+
+export default PurchaseResult;

package/src/dto/StoreTransaction.ts

@@ -0,0 +1,61 @@
+/**
+ * Represents a raw store transaction from the native platform.
+ * This is the transaction information as received from Apple App Store or Google Play Store.
+ */
+class StoreTransaction {
+  /**
+   * The unique identifier for this transaction.
+   */
+  transactionId?: string;
+
+  /**
+   * The original transaction identifier.
+   * For subscriptions, this identifies the first transaction in the subscription chain.
+   */
+  originalTransactionId?: string;
+
+  /**
+   * The date and time when the transaction occurred.
+   */
+  transactionDate?: Date;
+
+  /**
+   * The store product identifier associated with this transaction.
+   */
+  productId?: string;
+
+  /**
+   * The quantity of items purchased.
+   */
+  quantity: number;
+
+  /**
+   * iOS only. The identifier of the promotional offer applied to this purchase.
+   */
+  promoOfferId?: string;
+
+  /**
+   * Android only. The purchase token from Google Play.
+   */
+  purchaseToken?: string;
+
+  constructor(
+    transactionId: string | undefined,
+    originalTransactionId: string | undefined,
+    transactionTimestamp: number | undefined,
+    productId: string | undefined,
+    quantity: number | undefined,
+    promoOfferId: string | undefined,
+    purchaseToken: string | undefined,
+  ) {
+    this.transactionId = transactionId;
+    this.originalTransactionId = originalTransactionId;
+    this.transactionDate = transactionTimestamp ? new Date(transactionTimestamp) : undefined;
+    this.productId = productId;
+    this.quantity = quantity ?? 1;
+    this.promoOfferId = promoOfferId;
+    this.purchaseToken = purchaseToken;
+  }
+}
+
+export default StoreTransaction;

package/src/dto/enums.ts

@@ -388,3 +388,43 @@ export enum NoCodesErrorCode {
   SCREEN_LOADING_FAILED = "ScreenLoadingFailed", // iOS
   SDK_INITIALIZATION_ERROR = "SDKInitializationError" // iOS
 }
+
+/**
+ * Status of the purchase result.
+ */
+export enum PurchaseResultStatus {
+  /**
+   * The purchase was successful.
+   */
+  SUCCESS = "Success",
+
+  /**
+   * The purchase was canceled by the user.
+   */
+  USER_CANCELED = "UserCanceled",
+
+  /**
+   * The purchase is pending (e.g., waiting for parental approval).
+   */
+  PENDING = "Pending",
+
+  /**
+   * An error occurred during the purchase.
+   */
+  ERROR = "Error",
+}
+
+/**
+ * Source of the purchase result data.
+ */
+export enum PurchaseResultSource {
+  /**
+   * The result was obtained from the Qonversion API.
+   */
+  API = "Api",
+
+  /**
+   * The result was obtained from the local store.
+   */
+  LOCAL = "Local",
+}

package/src/index.ts

@@ -31,6 +31,8 @@ export { default as SKProductDiscount } from './dto/storeProducts/SKProductDisco
 export { default as SKSubscriptionPeriod } from './dto/storeProducts/SKSubscriptionPeriod';
 export { default as PurchaseOptionsBuilder } from './dto/PurchaseOptionsBuilder';
 export { default as PurchaseOptions } from './dto/PurchaseOptionsBuilder';
+export { default as PurchaseResult } from './dto/PurchaseResult';
+export { default as StoreTransaction } from './dto/StoreTransaction';
 
 // NoCode exports
 export { default as ScreenPresentationConfig } from './dto/ScreenPresentationConfig';
@@ -39,4 +41,6 @@ export type { default as NoCodesApi } from './NoCodesApi';
 export { default as NoCodesConfig } from './NoCodesConfig';
 export { default as NoCodesConfigBuilder } from './NoCodesConfigBuilder';
 export type { NoCodesListener } from './dto/NoCodesListener';
+export type { PurchaseDelegate } from './dto/PurchaseDelegate';
 export { default as NoCodesAction } from './dto/NoCodesAction';
+export { default as NoCodesError } from './dto/NoCodesError';

package/src/internal/Mapper.ts

@@ -8,6 +8,8 @@ import {
   PricingPhaseRecurrenceMode,
   PricingPhaseType,
   ProductType,
+  PurchaseResultSource,
+  PurchaseResultStatus,
   QonversionErrorCode,
   RemoteConfigurationAssignmentType,
   RemoteConfigurationSourceType,
@@ -52,6 +54,8 @@ import SKPaymentDiscount from '../dto/storeProducts/SKPaymentDiscount';
 import NoCodesAction from '../dto/NoCodesAction';
 import QonversionError from '../dto/QonversionError';
 import NoCodesError from '../dto/NoCodesError';
+import PurchaseResult from '../dto/PurchaseResult';
+import StoreTransaction from '../dto/StoreTransaction';
 
 export type QProduct = {
   id: string;
@@ -298,6 +302,25 @@ export type QNoCodesError = QQonversionError & {
 
 export type QNoCodeScreenInfo = { screenId: string };
 
+export type QStoreTransaction = {
+  transactionId?: string | null;
+  originalTransactionId?: string | null;
+  transactionTimestamp?: number | null;
+  productId?: string | null;
+  quantity?: number | null;
+  promoOfferId?: string | null;
+  purchaseToken?: string | null;
+};
+
+export type QPurchaseResult = {
+  status: string;
+  entitlements: Record<string, QEntitlement> | null;
+  error: QQonversionError | null | undefined;
+  isFallbackGenerated: boolean;
+  source: string;
+  storeTransaction: QStoreTransaction | null | undefined;
+};
+
 const priceMicrosRatio = 1000000;
 
 class Mapper {
@@ -1156,6 +1179,77 @@ class Mapper {
 
     return QonversionErrorCode.UNKNOWN;
   }
+
+  // region PurchaseResult Mappers
+
+  static convertPurchaseResult(
+    purchaseResult: QPurchaseResult | null | undefined
+  ): PurchaseResult | null {
+    if (!purchaseResult) {
+      return null;
+    }
+
+    const status = this.convertPurchaseResultStatus(purchaseResult.status);
+    const entitlements = purchaseResult.entitlements
+      ? this.convertEntitlements(purchaseResult.entitlements)
+      : null;
+    const error = purchaseResult.error ? this.convertQonversionError(purchaseResult.error) : undefined;
+    const source = this.convertPurchaseResultSource(purchaseResult.source);
+    const storeTransaction = this.convertStoreTransaction(purchaseResult.storeTransaction);
+
+    return new PurchaseResult(
+      status,
+      entitlements,
+      error ?? null,
+      purchaseResult.isFallbackGenerated ?? false,
+      source,
+      storeTransaction
+    );
+  }
+
+  static convertPurchaseResultStatus(status: string | null | undefined): PurchaseResultStatus {
+    switch (status) {
+      case "Success":
+        return PurchaseResultStatus.SUCCESS;
+      case "UserCanceled":
+        return PurchaseResultStatus.USER_CANCELED;
+      case "Pending":
+        return PurchaseResultStatus.PENDING;
+      case "Error":
+      default:
+        return PurchaseResultStatus.ERROR;
+    }
+  }
+
+  static convertPurchaseResultSource(source: string | null | undefined): PurchaseResultSource {
+    switch (source) {
+      case "Local":
+        return PurchaseResultSource.LOCAL;
+      case "Api":
+      default:
+        return PurchaseResultSource.API;
+    }
+  }
+
+  static convertStoreTransaction(
+    storeTransaction: QStoreTransaction | null | undefined
+  ): StoreTransaction | null {
+    if (!storeTransaction) {
+      return null;
+    }
+
+    return new StoreTransaction(
+      storeTransaction.transactionId ?? undefined,
+      storeTransaction.originalTransactionId ?? undefined,
+      storeTransaction.transactionTimestamp ?? undefined,
+      storeTransaction.productId ?? undefined,
+      storeTransaction.quantity ?? undefined,
+      storeTransaction.promoOfferId ?? undefined,
+      storeTransaction.purchaseToken ?? undefined
+    );
+  }
+
+  // endregion
 }
 
 export default Mapper;

package/src/internal/NoCodesInternal.ts

@@ -1,12 +1,14 @@
 import type NoCodesApi from "../NoCodesApi";
 import NoCodesConfig from "../NoCodesConfig";
-import Mapper, { type QNoCodeAction, type QNoCodesError, type QNoCodeScreenInfo } from "./Mapper";
+import Mapper, { type QNoCodeAction, type QNoCodesError, type QNoCodeScreenInfo, type QProduct } from "./Mapper";
 import type {NoCodesListener} from '../dto/NoCodesListener';
+import type {PurchaseDelegate} from '../dto/PurchaseDelegate';
 import ScreenPresentationConfig from '../dto/ScreenPresentationConfig';
 import NoCodesError from '../dto/NoCodesError';
 import {NoCodesErrorCode} from '../dto/enums';
 import RNNoCodes, {type NoCodeEvent} from './specs/NativeNoCodesModule';
 import {sdkSource, sdkVersion} from './QonversionInternal';
+import Product from '../dto/Product';
 
 const EVENT_SCREEN_SHOWN = "nocodes_screen_shown";
 const EVENT_FINISHED = "nocodes_finished";
@@ -17,13 +19,18 @@ const EVENT_SCREEN_FAILED_TO_LOAD = "nocodes_screen_failed_to_load";
 
 export default class NoCodesInternal implements NoCodesApi {
   private noCodesListener: NoCodesListener | null = null;
+  private purchaseDelegate: PurchaseDelegate | null = null;
 
   constructor(config: NoCodesConfig) {
-    RNNoCodes.initialize(config.projectKey, sdkSource, sdkVersion, config.proxyUrl);
+    RNNoCodes.initialize(config.projectKey, sdkSource, sdkVersion, config.proxyUrl, config.locale);
 
     if (config.noCodesListener) {
       this.setNoCodesListener(config.noCodesListener);
     }
+
+    if (config.purchaseDelegate) {
+      this.setPurchaseDelegate(config.purchaseDelegate);
+    }
   }
 
   async setScreenPresentationConfig(config: ScreenPresentationConfig, contextKey?: string) {
@@ -44,7 +51,7 @@ export default class NoCodesInternal implements NoCodesApi {
       case EVENT_SCREEN_SHOWN:
         const screenId = (event.payload as QNoCodeScreenInfo)["screenId"] ?? "";
         this.noCodesListener?.onScreenShown(screenId);
-        break;  
+        break;
       case EVENT_ACTION_STARTED:
         const actionStarted = Mapper.convertAction(event.payload as QNoCodeAction);
         this.noCodesListener?.onActionStartedExecuting(actionStarted);
@@ -75,10 +82,44 @@ export default class NoCodesInternal implements NoCodesApi {
     }
   }
 
+  private customPurchaseHandler = async (productData: Object) => {
+    if (!this.purchaseDelegate) {
+      throw new Error('PurchaseDelegate is not set but custom purchase handling initiated');
+    }
+    const product: Product = Mapper.convertProduct(productData as QProduct);
+    this.purchaseDelegate.purchase(product).then(() => {
+      RNNoCodes.delegatedPurchaseCompleted();
+    }).catch((error: Error) => {
+      RNNoCodes.delegatedPurchaseFailed(error.message);
+    });
+  }
+
+  private customRestoreHandler = async () => {
+    if (!this.purchaseDelegate) {
+      throw new Error('PurchaseDelegate is not set but custom restore handling initiated');
+    }
+    this.purchaseDelegate.restore().then(() => {
+      RNNoCodes.delegatedRestoreCompleted();
+    }).catch((error: Error) => {
+      RNNoCodes.delegatedRestoreFailed(error.message);
+    });
+  }
+
   setNoCodesListener(listener: NoCodesListener) {
     if (this.noCodesListener == null) {
       RNNoCodes.onNoCodeEvent(this.noCodeEventHandler);
     }
     this.noCodesListener = listener;
   }
+
+  setPurchaseDelegate(delegate: PurchaseDelegate) {
+    this.purchaseDelegate = delegate;
+    RNNoCodes.onNoCodePurchase(this.customPurchaseHandler);
+    RNNoCodes.onNoCodeRestore(this.customRestoreHandler);
+    RNNoCodes.setPurchaseDelegate();
+  }
+
+  setLocale(locale: string | null) {
+    RNNoCodes.setLocale(locale);
+  }
 }

package/src/internal/QonversionInternal.ts

@@ -1,10 +1,11 @@
 import {AttributionProvider, QonversionErrorCode, UserPropertyKey} from "../dto/enums";
 import IntroEligibility from "../dto/IntroEligibility";
 import Mapper from "./Mapper";
-import type {QEntitlement, QEligibilityInfo, QProduct} from "./Mapper";
+import type {QEntitlement, QEligibilityInfo, QProduct, QPurchaseResult} from "./Mapper";
 import Offerings from "../dto/Offerings";
 import Entitlement from "../dto/Entitlement";
 import Product from "../dto/Product";
+import PurchaseResult from "../dto/PurchaseResult";
 import {isAndroid, isIos} from "./utils";
 import type {EntitlementsUpdateListener} from '../dto/EntitlementsUpdateListener';
 import type {PromoPurchasesListener} from '../dto/PromoPurchasesListener';
@@ -23,7 +24,7 @@ import PromotionalOffer from '../dto/PromotionalOffer';
 import RNQonversion from './specs/NativeQonversionModule';
 import type { QPromoOfferDetails } from './specs/NativeQonversionModule';
 
-export const sdkVersion = "10.0.1";
+export const sdkVersion = "10.1.0";
 export const sdkSource = "rn";
 
 export default class QonversionInternal implements QonversionApi {
@@ -73,6 +74,53 @@ export default class QonversionInternal implements QonversionApi {
     return mappedPromoOffer;
   }
 
+  async purchaseWithResult(product: Product, options: PurchaseOptions | undefined): Promise<PurchaseResult> {
+    if (!options) {
+      options = new PurchaseOptionsBuilder().build();
+    }
+
+    const promoOffer: QPromoOfferDetails = {
+      productDiscountId: options.promotionalOffer?.productDiscount.identifier,
+      keyIdentifier: options.promotionalOffer?.paymentDiscount.keyIdentifier,
+      nonce: options.promotionalOffer?.paymentDiscount.nonce,
+      signature: options.promotionalOffer?.paymentDiscount.signature,
+      timestamp: options.promotionalOffer?.paymentDiscount.timestamp
+    };
+
+    let purchaseResultPromise: Promise<QPurchaseResult | null | undefined>;
+    if (isIos()) {
+      purchaseResultPromise = RNQonversion.purchaseWithResult(
+        product.qonversionId,
+        options.quantity,
+        options.contextKeys,
+        promoOffer,
+        undefined,
+        false,
+        undefined,
+        undefined,
+      );
+    } else {
+      purchaseResultPromise = RNQonversion.purchaseWithResult(
+        product.qonversionId,
+        1,
+        options.contextKeys,
+        undefined,
+        options.offerId,
+        options.applyOffer,
+        options.oldProduct?.qonversionId,
+        options.updatePolicy,
+      );
+    }
+    const purchaseResult = await purchaseResultPromise;
+    const mappedResult = Mapper.convertPurchaseResult(purchaseResult);
+
+    if (!mappedResult) {
+      throw new Error("Failed to parse PurchaseResult");
+    }
+
+    return mappedResult;
+  }
+
   async purchaseProduct(product: Product, options: PurchaseOptions | undefined): Promise<Map<string, Entitlement>> {
     try {
       if (!options) {

package/src/internal/specs/NativeNoCodesModule.ts

@@ -9,12 +9,22 @@ export type NoCodeEvent = {
 };
 
 export interface Spec extends TurboModule {
-  initialize(projectKey: string, source: string, version: string, proxyUrl?: string): void;
+  initialize(projectKey: string, source: string, version: string, proxyUrl?: string, locale?: string): void;
   setScreenPresentationConfig(configData: Object, contextKey?: string): Promise<boolean>;
   showScreen(contextKey: string): Promise<boolean>;
   close(): Promise<boolean>;
+  setPurchaseDelegate(): void;
+  setLocale(locale: string | null): void;
+
+  // Methods to notify native code about purchase/restore results
+  delegatedPurchaseCompleted(): void;
+  delegatedPurchaseFailed(errorMessage: string): void;
+  delegatedRestoreCompleted(): void;
+  delegatedRestoreFailed(errorMessage: string): void;
 
   readonly onNoCodeEvent: EventEmitter<NoCodeEvent>;
+  readonly onNoCodePurchase: EventEmitter<Object>; // QProduct
+  readonly onNoCodeRestore: EventEmitter<void>;
 }
 
 export default TurboModuleRegistry.getEnforcing<Spec>('RNNoCodes');

package/src/internal/specs/NativeQonversionModule.ts

@@ -1,6 +1,6 @@
 import type {TurboModule} from 'react-native';
 import {TurboModuleRegistry} from 'react-native';
-import type { QPromotionalOffer, QOfferings, QUser, QUserProperties, QRemoteConfig, QRemoteConfigList } from '../Mapper';
+import type { QPromotionalOffer, QOfferings, QUser, QUserProperties, QRemoteConfig, QRemoteConfigList, QPurchaseResult } from '../Mapper';
 import type { EventEmitter } from 'react-native/Libraries/Types/CodegenTypes';
 
 export type QPromoOfferDetails = {
@@ -34,7 +34,17 @@ export interface Spec extends TurboModule {
     applyOffer: boolean, // Android only
     oldProductId: string | null | undefined, // Android only
     updatePolicyKey: string | null | undefined, // Android only
-  ): Promise<Object | null | undefined>; // Record<string, QEntitlement
+  ): Promise<Object | null | undefined>; // Record<string, QEntitlement>
+  purchaseWithResult(
+    productId: string,
+    quantity: number, // iOS only
+    contextKeys: string[] | null | undefined,
+    promoOffer: QPromoOfferDetails | undefined, // iOS only
+    offerId: string | null | undefined, // Android only
+    applyOffer: boolean, // Android only
+    oldProductId: string | null | undefined, // Android only
+    updatePolicyKey: string | null | undefined, // Android only
+  ): Promise<QPurchaseResult | null | undefined>;
   updatePurchase(
     productId: string,
     offerId: string | null | undefined,