@revenuecat/purchases-js 0.11.2 → 0.12.0

package/dist/Purchases.es.d.ts

@@ -308,6 +308,7 @@ export declare interface Offering {
 
 /**
  * Keywords for identifying specific offerings in the {@link Purchases.getOfferings} method.
+ * @public
  */
 export declare enum OfferingKeyword {
     /**
@@ -635,6 +636,21 @@ export declare interface PurchaseParams {
     customerEmail?: string;
 }
 
+/**
+ * Represents the result of a purchase operation.
+ * @public
+ */
+export declare interface PurchaseResult {
+    /**
+     * The customer information after the purchase.
+     */
+    readonly customerInfo: CustomerInfo;
+    /**
+     * The redemption information after the purchase if available.
+     */
+    readonly redemptionInfo: RedemptionInfo | null;
+}
+
 /**
  * Entry point for Purchases SDK. It should be instantiated as soon as your
  * app is started. Only one instance of Purchases should be instantiated
@@ -712,21 +728,17 @@ export declare class Purchases {
         * @returns a Promise for the customer info after the purchase is completed successfully.
         * @throws {@link PurchasesError} if there is an error while performing the purchase. If the {@link PurchasesError.errorCode} is {@link ErrorCode.UserCancelledError}, the user cancelled the purchase.
             */
-        purchasePackage(rcPackage: Package, customerEmail?: string, htmlTarget?: HTMLElement): Promise<{
-            customerInfo: CustomerInfo;
-        }>;
+        purchasePackage(rcPackage: Package, customerEmail?: string, htmlTarget?: HTMLElement): Promise<PurchaseResult>;
         /**
          * Method to perform a purchase for a given package. You can obtain the
          * package from {@link Purchases.getOfferings}. This method will present the purchase
          * form on your site, using the given HTML element as the mount point, if
          * provided, or as a modal if not.
          * @param params - The parameters object to customise the purchase flow. Check {@link PurchaseParams}
-         * @returns a Promise for the customer info after the purchase is completed successfully.
+         * @returns a Promise for the customer and redemption info after the purchase is completed successfully.
          * @throws {@link PurchasesError} if there is an error while performing the purchase. If the {@link PurchasesError.errorCode} is {@link ErrorCode.UserCancelledError}, the user cancelled the purchase.
              */
-         purchase(params: PurchaseParams): Promise<{
-             customerInfo: CustomerInfo;
-         }>;
+         purchase(params: PurchaseParams): Promise<PurchaseResult>;
          /**
           * Gets latest available {@link CustomerInfo}.
           * @returns The latest {@link CustomerInfo}.
@@ -810,6 +822,18 @@ export declare class Purchases {
              readonly backendErrorCode?: number;
          }
 
+         /**
+          * This object gives you access to the purchase redemption data when
+          * the purchase can be redeemed to a mobile user, like in the case of anonymous users.
+          * @public
+          */
+         export declare interface RedemptionInfo {
+             /**
+              * The redeem url.
+              */
+             readonly redeemUrl: string | null;
+         }
+
          /**
           * The store where the user originally subscribed.
           * @public