@qonversion/react-native-sdk 10.0.0-RC1

package/src/dto/Offerings.ts

@@ -0,0 +1,17 @@
+import Offering from "./Offering";
+
+class Offerings {
+  main: Offering | null;
+  availableOffering: Array<Offering>;
+
+  constructor(main: Offering | null, availableOfferings: Array<Offering>) {
+    this.main = main;
+    this.availableOffering = availableOfferings;
+  }
+
+  offeringForIdentifier(identifier: string): Offering | undefined {
+    return this.availableOffering.find((object) => object.id === identifier);
+  }
+}
+
+export default Offerings;

package/src/dto/Product.ts

@@ -0,0 +1,159 @@
+import {ProductType, PurchaseUpdatePolicy} from "./enums";
+import SKProduct from "./storeProducts/SKProduct";
+import SkuDetails from "./storeProducts/SkuDetails";
+import ProductStoreDetails from "./storeProducts/ProductStoreDetails";
+import ProductOfferDetails from './storeProducts/ProductOfferDetails';
+import PurchaseModel from './PurchaseModel';
+import PurchaseUpdateModel from './PurchaseUpdateModel';
+import SubscriptionPeriod from './SubscriptionPeriod';
+
+class Product {
+  qonversionId: string;
+  storeId: string | null;
+
+  /**
+   * Identifier of the base plan for Google product.
+   */
+  basePlanId: string | null;
+
+  /**
+   * Google Play Store details of this product.
+   * Android only. Null for iOS, or if the product was not found.
+   * Doesn't take into account {@link basePlanId}.
+   * @deprecated Consider using {@link storeDetails} instead.
+   */
+  skuDetails: SkuDetails | null;
+
+  /**
+   * Google Play Store details of this product.
+   * Android only. Null for iOS, or if the product was not found.
+   */
+  storeDetails: ProductStoreDetails | null;
+
+  /**
+   * App store details of this product.
+   * iOS only. Null for Android, or if the product was not found.
+   */
+  skProduct: SKProduct | null;
+
+  offeringId?: string | null;
+
+  /**
+   * For Android - the subscription base plan duration. If the {@link basePlanId} is not specified,
+   * the duration is calculated using the deprecated {@link skuDetails}.
+   * For iOS - the duration of the {@link skProduct}.
+   * Null, if it's not a subscription product or the product was not found in the store.
+   */
+  subscriptionPeriod: SubscriptionPeriod | null;
+
+  /**
+   * The subscription trial duration of the default offer for Android or of the product for iOS.
+   * See {@link ProductStoreDetails.defaultSubscriptionOfferDetails} for the information on how we
+   * choose the default offer for Android.
+   * Null, if it's not a subscription product or the product was not found the store.
+   */
+  trialPeriod: SubscriptionPeriod | null;
+
+  /**
+   * The calculated type of this product based on the store information.
+   * On Android uses deprecated {@link skuDetails} for the old subscription products
+   * where {@link basePlanId} is not specified, and {@link storeDetails} for all the other products.
+   * On iOS uses {@link skProduct} information.
+   */
+  type: ProductType;
+
+  /**
+   * Formatted price of for this product, including the currency sign.
+   */
+  prettyPrice: string | null;
+
+  price?: number;
+  currencyCode?: string;
+  storeTitle?: string;
+  storeDescription?: string;
+  prettyIntroductoryPrice?: string;
+
+  constructor(
+    qonversionId: string,
+    storeId: string,
+    basePlanId: string | null,
+    skuDetails: SkuDetails | null,
+    storeDetails: ProductStoreDetails | null,
+    skProduct: SKProduct | null,
+    offeringId: string | null,
+    subscriptionPeriod: SubscriptionPeriod | null,
+    trialPeriod: SubscriptionPeriod | null,
+    type: ProductType,
+    prettyPrice: string | null,
+    price: number | undefined,
+    currencyCode: string | undefined,
+    storeTitle: string | undefined,
+    storeDescription: string | undefined,
+    prettyIntroductoryPrice: string | undefined,
+  ) {
+    this.qonversionId = qonversionId;
+    this.storeId = storeId;
+    this.basePlanId = basePlanId;
+    this.skuDetails = skuDetails;
+    this.storeDetails = storeDetails;
+    this.skProduct = skProduct;
+    this.offeringId = offeringId;
+    this.subscriptionPeriod = subscriptionPeriod;
+    this.trialPeriod = trialPeriod;
+    this.type = type;
+    this.prettyPrice = prettyPrice;
+    this.price = price;
+    this.currencyCode = currencyCode;
+    this.storeTitle = storeTitle;
+    this.storeDescription = storeDescription;
+    this.prettyIntroductoryPrice = prettyIntroductoryPrice;
+  }
+
+  /**
+   * Converts this product to purchase model to pass to {@link Qonversion.purchase}.
+   * @param offerId concrete Android offer identifier if necessary.
+   *                If the products' base plan id is specified, but offer id is not provided for
+   *                purchase, then default offer will be used.
+   *                Ignored if base plan id is not specified.
+   *                Ignored for iOS.
+   * To know how we choose the default offer, see {@link ProductStoreDetails.defaultSubscriptionOfferDetails}.
+   * @returns purchase model to pass to the purchase method.
+   */
+  toPurchaseModel(offerId: string | null = null): PurchaseModel {
+    return new PurchaseModel(this.qonversionId, offerId);
+  }
+
+  /**
+   * Converts this product to purchase model to pass to {@link Qonversion.purchase}.
+   * @param offer concrete Android offer which you'd like to purchase.
+   * @return purchase model to pass to the purchase method.
+   */
+  toPurchaseModelWithOffer(offer: ProductOfferDetails): PurchaseModel {
+    const model = this.toPurchaseModel(offer.offerId);
+    // Remove offer for the case when provided offer details are for bare base plan.
+    if (offer.offerId == null) {
+      model.removeOffer();
+    }
+
+    return model;
+  }
+
+  /**
+   * Android only.
+   *
+   * Converts this product to purchase update (upgrade/downgrade) model
+   * to pass to {@link Qonversion.updatePurchase}.
+   * @param oldProductId Qonversion product identifier from which the upgrade/downgrade
+   *                     will be initialized.
+   * @param updatePolicy purchase update policy.
+   * @return purchase model to pass to the update purchase method.
+   */
+  toPurchaseUpdateModel(
+    oldProductId: string,
+    updatePolicy: PurchaseUpdatePolicy | null = null
+  ): PurchaseUpdateModel {
+    return new PurchaseUpdateModel(this.qonversionId, oldProductId, updatePolicy);
+  }
+}
+
+export default Product;

package/src/dto/PromoPurchasesListener.ts

@@ -0,0 +1,13 @@
+import Entitlement from './Entitlement';
+
+export interface PromoPurchasesListener {
+
+  /**
+   * Fired each time a promo purchase from the App Store happens.
+   * Call {@param promoPurchaseExecutor} in case of your app is ready to start promo purchase.
+   * Or cache that executor and call later when you need.
+   * @param productId StoreKit product identifier.
+   * @param promoPurchaseExecutor a function that will start a promo purchase flow.
+   */
+  onPromoPurchaseReceived(productId: string, promoPurchaseExecutor: () => Promise<Map<string, Entitlement>>): void;
+}

package/src/dto/PromotionalOffer.ts

@@ -0,0 +1,17 @@
+import SKProductDiscount from './storeProducts/SKProductDiscount';
+import SKPaymentDiscount from './storeProducts/SKPaymentDiscount';
+
+class PromotionalOffer {
+    public readonly productDiscount: SKProductDiscount;
+    public readonly paymentDiscount: SKPaymentDiscount;
+
+    constructor (
+        productDiscount: SKProductDiscount,
+        paymentDiscount: SKPaymentDiscount
+    ) {
+        this.productDiscount = productDiscount;
+        this.paymentDiscount = paymentDiscount;
+    }
+}
+
+export default PromotionalOffer;

package/src/dto/PurchaseModel.ts

@@ -0,0 +1,29 @@
+/**
+ * Used to provide all the necessary purchase data to the {@link Qonversion.purchase} method.
+ * Can be created manually or using the {@link Product.toPurchaseModel} method.
+ *
+ * If {@link offerId} is not specified for Android, then the default offer will be applied.
+ * To know how we choose the default offer, see {@link ProductStoreDetails.defaultSubscriptionOfferDetails}.
+ *
+ * If you want to remove any intro/trial offer from the purchase on Android (use only a bare base plan),
+ * call the {@link removeOffer} method.
+ */
+class PurchaseModel {
+
+  public readonly productId: string;
+  public offerId: string | null = null;
+
+  public applyOffer: boolean = true;
+
+  constructor(productId: string, offerId: string | null = null) {
+    this.productId = productId;
+    this.offerId = offerId;
+  }
+
+  removeOffer(): PurchaseModel {
+    this.applyOffer = false;
+    return this;
+  }
+}
+
+export default PurchaseModel;

package/src/dto/PurchaseOptions.ts

@@ -0,0 +1,33 @@
+import Product from "./Product";
+import {PurchaseUpdatePolicy} from "./enums";
+import PromotionalOffer from './PromotionalOffer';
+
+class PurchaseOptions {
+    public readonly offerId: string | null;
+    public readonly applyOffer: boolean;
+    public readonly oldProduct: Product | null;
+    public readonly updatePolicy: PurchaseUpdatePolicy | null;
+    public readonly contextKeys: string[] | null;
+    public readonly quantity: number;
+    public readonly promotionalOffer: PromotionalOffer | null;
+
+    constructor (
+        offerId: string | null,
+        applyOffer: boolean,
+        oldProduct: Product | null,
+        updatePolicy: PurchaseUpdatePolicy | null,
+        contextKeys: string[] | null,
+        quantity: number,
+        promotionalOffer: PromotionalOffer | null
+    ) {
+        this.offerId = offerId;
+        this.applyOffer = applyOffer;
+        this.oldProduct = oldProduct;
+        this.updatePolicy = updatePolicy;
+        this.contextKeys = contextKeys;
+        this.quantity = quantity;
+        this.promotionalOffer = promotionalOffer;
+    }
+}
+
+export default PurchaseOptions;

package/src/dto/PurchaseOptionsBuilder.ts

@@ -0,0 +1,127 @@
+import Product from "./Product";
+import {PurchaseUpdatePolicy} from "./enums";
+import ProductOfferDetails from "./storeProducts/ProductOfferDetails";
+import PurchaseOptions from "./PurchaseOptions";
+import PromotionalOffer from "./PromotionalOffer";
+
+class PurchaseOptionsBuilder {
+    private offerId: string | null = null;
+    private applyOffer: boolean = true;
+    private oldProduct: Product | null = null;
+    private updatePolicy: PurchaseUpdatePolicy | null = null;
+    private contextKeys: string[] | null = null;
+    private quantity: number = 1;
+    private promoOffer: PromotionalOffer | null = null;
+
+    /**
+     * iOS only.
+     * Set quantity of product purchasing. Use for consumable in-app products.
+     * @param quantity of product purchasing.
+     * @return builder instance for chain calls.
+     */
+    setQuantity(quantity: number): PurchaseOptionsBuilder {
+        this.quantity = quantity;
+        return this;
+    }
+
+    /**
+     * Android only.
+     * Set offer for the purchase.
+     * If offer is not specified, then the default offer will be applied. To know how we choose
+     * the default offer, see {@link ProductStoreDetails.defaultSubscriptionOfferDetails}.
+     * @param offer concrete offer which you'd like to purchase.
+     * @return builder instance for chain calls.
+     */
+    setOffer(offer: ProductOfferDetails) {
+        this.offerId = offer.offerId;
+        return this;
+    }
+
+    /**
+     * Android only.
+     * Set the offer Id to the purchase.
+     * If {@link offerId} is not specified, then the default offer will be applied. To know how we choose
+     * the default offer, see {@link ProductStoreDetails.defaultSubscriptionOfferDetails}.
+     * @param offerId concrete offer Id which you'd like to purchase.
+     * @return builder instance for chain calls.
+     */
+    setOfferId(offerId: string): PurchaseOptionsBuilder {
+        this.offerId = offerId;
+        return this;
+    }
+
+    /**
+     * Android only.
+     * Call this function to remove any intro/trial offer from the purchase (use only a bare base plan).
+     * @return builder instance for chain calls.
+     */
+    removeOffer(): PurchaseOptionsBuilder {
+        this.applyOffer = false;
+        return this;
+    }
+
+    /**
+     * Android only.
+     * Set Qonversion product from which the upgrade/downgrade will be initialized.
+     *
+     * @param oldProduct Qonversion product from which the upgrade/downgrade
+     * will be initialized.
+     * @return builder instance for chain calls.
+     */
+    setOldProduct(oldProduct: Product): PurchaseOptionsBuilder {
+        this.oldProduct = oldProduct;
+        return this;
+    }
+
+    /**
+     * Android only.
+     * Set the update policy for the purchase.
+     * If the {@link updatePolicy} is not provided, then default one
+     * will be selected - {@link PurchaseUpdatePolicy.WITH_TIME_PRORATION}.
+     * @param updatePolicy update policy for the purchase.
+     * @return builder instance for chain calls.
+     */
+    setUpdatePolicy(updatePolicy: PurchaseUpdatePolicy): PurchaseOptionsBuilder {
+        this.updatePolicy = updatePolicy;
+        return this;
+    }
+
+    /**
+     * Set the context keys associated with a purchase.
+     *
+     * @param contextKeys context keys for the purchase.
+     * @return builder instance for chain calls.
+     */
+    setContextKeys(contextKeys: string[]): PurchaseOptionsBuilder {
+        this.contextKeys = contextKeys;
+        return this;
+    }
+
+    /**
+     * Set the promotional offer details.
+     *
+     * @param promoOffer promotional offer details.
+     * @return builder instance for chain calls.
+     */
+    setPromotionalOffer(promoOffer: PromotionalOffer): PurchaseOptionsBuilder {
+        this.promoOffer = promoOffer;
+        return this;
+    }
+
+    /**
+     * Generate {@link PurchaseOptions} instance with all the provided options.
+     * @return the complete {@link PurchaseOptions} instance.
+     */
+    build(): PurchaseOptions {
+        return new PurchaseOptions(
+            this.offerId,
+            this.applyOffer,
+            this.oldProduct,
+            this.updatePolicy,
+            this.contextKeys,
+            this.quantity,
+            this.promoOffer);
+    }
+}
+
+export default PurchaseOptionsBuilder;

package/src/dto/PurchaseUpdateModel.ts

@@ -0,0 +1,43 @@
+import {PurchaseUpdatePolicy} from './enums';
+
+/**
+ * Used to provide all the necessary purchase data to the {@link Qonversion.updatePurchase} method.
+ * Can be created manually or using the {@link Product.toPurchaseUpdateModel} method.
+ *
+ * Requires Qonversion product identifiers - {@link productId} for the purchasing one and
+ * {@link oldProductId} for the purchased one.
+ *
+ * If {@link offerId} is not specified for Android, then the default offer will be applied.
+ * To know how we choose the default offer, see {@link ProductStoreDetails.defaultSubscriptionOfferDetails}.
+ *
+ * If you want to remove any intro/trial offer from the purchase on Android (use only a bare base plan),
+ * call the {@link removeOffer} method.
+ */
+class PurchaseUpdateModel {
+
+  public readonly productId: string;
+  public readonly oldProductId: string;
+  public updatePolicy: PurchaseUpdatePolicy | null = null;
+  public offerId: string | null = null;
+
+  public applyOffer: boolean = true;
+
+  constructor(
+    productId: string,
+    oldProductId: string,
+    updatePolicy: PurchaseUpdatePolicy | null = null,
+    offerId: string | null = null,
+  ) {
+    this.productId = productId;
+    this.oldProductId = oldProductId;
+    this.updatePolicy = updatePolicy;
+    this.offerId = offerId;
+  }
+
+  removeOffer(): PurchaseUpdateModel {
+    this.applyOffer = false;
+    return this;
+  }
+}
+
+export default PurchaseUpdateModel;

package/src/dto/QonversionError.ts

@@ -0,0 +1,24 @@
+import {QonversionErrorCode} from './enums';
+
+class QonversionError {
+  code: QonversionErrorCode;
+  domain?: string | null;
+  description?: string | null;
+  additionalMessage?: string | null;
+  userCanceled: boolean = false;
+
+  constructor(
+    code: QonversionErrorCode,
+    description?: string | null,
+    additionalMessage?: string | null,
+    domain?: string | null,
+  ) {
+    this.code = code;
+    this.domain = domain;
+    this.description = description;
+    this.additionalMessage = additionalMessage;
+    this.userCanceled = code === QonversionErrorCode.PURCHASE_CANCELED;
+  }
+}
+
+export default QonversionError;

package/src/dto/RemoteConfig.ts

@@ -0,0 +1,16 @@
+import Experiment from "./Experiment";
+import RemoteConfigurationSource from "./RemoteConfigurationSource";
+
+class RemoteConfig {
+    payload: Record<string, Object>;
+    experiment?: Experiment | null;
+    source: RemoteConfigurationSource;
+
+    constructor(payload: Record<string, Object>, experiment: Experiment | null, source: RemoteConfigurationSource) {
+        this.payload = payload;
+        this.experiment = experiment;
+        this.source = source;
+    }
+}
+
+export default RemoteConfig;

package/src/dto/RemoteConfigList.ts

@@ -0,0 +1,23 @@
+import RemoteConfig from './RemoteConfig';
+
+class RemoteConfigList {
+    remoteConfigs: Array<RemoteConfig>;
+
+    constructor(remoteConfigs: Array<RemoteConfig>) {
+        this.remoteConfigs = remoteConfigs;
+    }
+
+    remoteConfigForContextKey(contextKey: string): RemoteConfig | undefined {
+        return this.findRemoteConfigForContextKey(contextKey);
+    }
+
+    remoteConfigForEmptyContextKey(): RemoteConfig | undefined {
+        return this.findRemoteConfigForContextKey(null);
+    }
+
+    private findRemoteConfigForContextKey(contextKey: string | null): RemoteConfig | undefined {
+        return this.remoteConfigs.find(config => config.source.contextKey == contextKey);
+    }
+}
+
+export default RemoteConfigList;

package/src/dto/RemoteConfigurationSource.ts

@@ -0,0 +1,26 @@
+import {RemoteConfigurationAssignmentType, RemoteConfigurationSourceType} from "./enums";
+
+
+class RemoteConfigurationSource {
+    id: string;
+    name: string;
+    type: RemoteConfigurationSourceType;
+    assignmentType: RemoteConfigurationAssignmentType;
+    contextKey: string | null;
+
+    constructor(
+      id: string,
+      name: string,
+      type: RemoteConfigurationSourceType,
+      assignmentType: RemoteConfigurationAssignmentType,
+      contextKey: string | null,
+    ) {
+        this.id = id;
+        this.name = name;
+        this.type = type;
+        this.assignmentType = assignmentType;
+        this.contextKey = contextKey;
+    }
+}
+
+export default RemoteConfigurationSource;

package/src/dto/ScreenPresentationConfig.ts

@@ -0,0 +1,24 @@
+import {ScreenPresentationStyle} from './enums';
+
+class ScreenPresentationConfig {
+  /**
+   * Describes how screens will be displayed.
+   * For mode details see the enum description.
+   */
+  presentationStyle: ScreenPresentationStyle;
+
+  /**
+   * iOS only. For Android consider using {@link ScreenPresentationStyle.NO_ANIMATION}.
+   *
+   * Describes whether should transaction be animated or not.
+   * Default value is true.
+   */
+  animated: boolean;
+
+  constructor(presentationStyle: ScreenPresentationStyle, animated?: boolean) {
+    this.presentationStyle = presentationStyle;
+    this.animated = animated === undefined ? true : animated;
+  }
+}
+
+export default ScreenPresentationConfig;

package/src/dto/SubscriptionPeriod.ts

@@ -0,0 +1,33 @@
+import {SubscriptionPeriodUnit} from "./enums";
+
+/**
+ * A class describing a subscription period
+ */
+class SubscriptionPeriod {
+  /**
+   * A count of subsequent intervals.
+   */
+  unitCount: number;
+
+  /**
+   * Interval unit.
+   */
+  unit: SubscriptionPeriodUnit;
+
+  /**
+   * ISO 8601 representation of the period, e.g. "P7D", meaning 7 days period.
+   */
+  iso: string;
+
+  constructor(
+    unitCount: number,
+    unit: SubscriptionPeriodUnit,
+    iso: string,
+  ) {
+    this.unitCount = unitCount;
+    this.unit = unit;
+    this.iso = iso;
+  }
+}
+
+export default SubscriptionPeriod;

package/src/dto/Transaction.ts

@@ -0,0 +1,40 @@
+import {TransactionEnvironment, TransactionOwnershipType, TransactionType} from "./enums";
+
+class Transaction {
+    originalTransactionId: string;
+    transactionId: string;
+    transactionDate: Date;
+    environment: TransactionEnvironment;
+    ownershipType: TransactionOwnershipType;
+    type: TransactionType;
+    expirationDate?: Date;
+    transactionRevocationDate?: Date;
+    offerCode?: string;
+    promoOfferId?: string;
+
+    constructor(
+        originalTransactionId: string,
+        transactionId: string,
+        transactionTimestamp: number,
+        environment: TransactionEnvironment,
+        ownershipType: TransactionOwnershipType,
+        type: TransactionType,
+        expirationTimestamp: number | undefined,
+        transactionRevocationTimestamp: number | undefined,
+        offerCode: string | undefined,
+        promoOfferId: string | undefined,
+    ) {
+        this.originalTransactionId = originalTransactionId;
+        this.transactionId = transactionId;
+        this.transactionDate = new Date(transactionTimestamp);
+        this.environment = environment;
+        this.ownershipType = ownershipType;
+        this.type = type;
+        this.expirationDate = expirationTimestamp ? new Date(expirationTimestamp) : undefined;
+        this.transactionRevocationDate = transactionRevocationTimestamp ? new Date(transactionRevocationTimestamp) : undefined;
+        this.offerCode = offerCode;
+        this.promoOfferId = promoOfferId;
+    }
+}
+
+export default Transaction;

package/src/dto/User.ts

@@ -0,0 +1,11 @@
+class User {
+  qonversionId: string;
+  identityId?: string | null;
+
+  constructor(qonversionId: string, identityId?: string | null) {
+    this.qonversionId = qonversionId;
+    this.identityId = identityId;
+  }
+}
+
+export default User;