@revenuecat/purchases-js 0.7.0 → 0.9.0

package/dist/Purchases.es.d.ts

@@ -230,6 +230,17 @@ export declare enum LogLevel {
     Verbose = 5
 }
 
+/**
+ * Represents a possible option to purchase a non-subscription product.
+ * @public
+ */
+export declare interface NonSubscriptionOption extends PurchaseOption {
+    /**
+     * The base price for the product.
+     */
+    readonly basePrice: Price;
+}
+
 /**
  * An offering is a collection of {@link Package} available for the user to purchase.
  * For more info see https://docs.revenuecat.com/docs/entitlements
@@ -419,6 +430,11 @@ export declare interface PresentedOfferingContext {
      * The targeting context used to obtain this object.
      */
     readonly targetingContext: TargetingContext | null;
+    /**
+     * If obtained this information from a placement,
+     * the identifier of the placement.
+     */
+    readonly placementIdentifier: string | null;
 }
 
 /**
@@ -496,13 +512,17 @@ export declare interface Product {
      */
     readonly description: string | null;
     /**
-     * Price of the product. In the case of subscriptions, this will match the
-     * default option's base phase price.
+     * Price of the product. This will match the default option's base phase price
+     * in subscriptions or the price in non-subscriptions.
      */
     readonly currentPrice: Price;
+    /**
+     * The type of product.
+     */
+    readonly productType: ProductType;
     /**
      * The period duration for a subscription product. This will match the default
-     * option's base phase period duration.
+     * option's base phase period duration. Null for non-subscriptions.
      */
     readonly normalPeriodDuration: string | null;
     /**
@@ -519,13 +539,14 @@ export declare interface Product {
      */
     readonly defaultPurchaseOption: PurchaseOption;
     /**
-     * The default subscription option for this product. Null if no subscription
-     * options are available like in the case of consumables and non-consumables.
+     * The default subscription option for this product.
+     * Null if no subscription options are available like in the case of consumables and non-consumables.
      */
     readonly defaultSubscriptionOption: SubscriptionOption | null;
     /**
      * A dictionary with all the possible subscription options available for this
      * product. Each key contains the key to be used when executing a purchase.
+     * Will be empty for non-subscriptions
      *
      * If retrieved through getOfferings the offers are only the ones the customer is
      * entitled to.
@@ -533,6 +554,30 @@ export declare interface Product {
     readonly subscriptionOptions: {
         [optionId: string]: SubscriptionOption;
     };
+    /**
+     * The default non-subscription option for this product.
+     * Null in the case of subscriptions.
+     */
+    readonly defaultNonSubscriptionOption: NonSubscriptionOption | null;
+}
+
+/**
+ * Possible product types
+ * @public
+ */
+export declare enum ProductType {
+    /**
+     * A product that is an auto-renewing subscription.
+     */
+    Subscription = "subscription",
+    /**
+     * A product that does not renew and can be consumed to be purchased again.
+     */
+    Consumable = "consumable",
+    /**
+     * A product that does not renew and can only be purchased once.
+     */
+    NonConsumable = "non_consumable"
 }
 
 /**
@@ -620,6 +665,14 @@ export declare class Purchases {
        * in the RevenueCat dashboard.
        */
       getOfferings(params?: GetOfferingsParams): Promise<Offerings>;
+      /**
+       * Retrieves a specific offering by a placement identifier.
+       * For more info see https://www.revenuecat.com/docs/tools/targeting
+       * @param placementIdentifier - The placement identifier to retrieve the offering for.
+       * @param params - The parameters object to customise the offerings fetch. Check {@link GetOfferingsParams}
+       */
+      getCurrentOfferingForPlacement(placementIdentifier: string, params?: GetOfferingsParams): Promise<Offering | null>;
+      private getAllOfferings;
       /**
        * Convenience method to check whether a user is entitled to a specific
        * entitlement. This will use {@link Purchases.getCustomerInfo} under the hood.
@@ -698,6 +751,10 @@ export declare class Purchases {
               * can be useful for debugging and logging.
               */
              readonly underlyingErrorMessage?: string | null | undefined;
+             /**
+              * Contains extra information that is available in certain types of errors.
+              */
+             readonly extra?: PurchasesErrorExtra | undefined;
              constructor(
              /**
               * Error code for the error. This is useful to appropriately react to
@@ -712,10 +769,29 @@ export declare class Purchases {
               * Underlying error message. This provides more details on the error and
               * can be useful for debugging and logging.
               */
-             underlyingErrorMessage?: string | null | undefined);
+             underlyingErrorMessage?: string | null | undefined, 
+             /**
+              * Contains extra information that is available in certain types of errors.
+              */
+             extra?: PurchasesErrorExtra | undefined);
              toString: () => string;
          }
 
+         /**
+          * Extra information that is available in certain types of errors.
+          * @public
+          */
+         export declare interface PurchasesErrorExtra {
+             /**
+              * If this is a request error, the HTTP status code of the response.
+              */
+             readonly statusCode?: number;
+             /**
+              * If this is a RevenueCat backend error, the error code from the servers.
+              */
+             readonly backendErrorCode?: number;
+         }
+
          /**
           * The store where the user originally subscribed.
           * @public