@revenuecat/purchases-js 0.8.0 → 0.10.0

package/dist/Purchases.es.d.ts

@@ -180,6 +180,11 @@ export declare interface GetOfferingsParams {
      * If not specified, the default currency will be used.
      */
     readonly currency?: string;
+    /**
+     * The identifier of the offering to fetch.
+     * Can be a string identifier or one of the predefined keywords.
+     */
+    readonly offeringIdentifier?: string | OfferingKeyword;
 }
 
 /**
@@ -230,6 +235,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
@@ -290,6 +306,16 @@ export declare interface Offering {
     readonly weekly: Package | null;
 }
 
+/**
+ * Keywords for identifying specific offerings in the {@link Purchases.getOfferings} method.
+ */
+export declare enum OfferingKeyword {
+    /**
+     * The current offering.
+     */
+    Current = "current"
+}
+
 /**
  * This class contains all the offerings configured in RevenueCat dashboard.
  * For more info see https://docs.revenuecat.com/docs/entitlements
@@ -297,13 +323,15 @@ export declare interface Offering {
  */
 export declare interface Offerings {
     /**
-     * Dictionary of all {@link Offering} objects keyed by their identifier.
+     * Dictionary containing all {@link Offering} objects, keyed by their identifier.
      */
     readonly all: {
         [offeringId: string]: Offering;
     };
     /**
      * Current offering configured in the RevenueCat dashboard.
+     * It can be `null` if no current offering is configured or if a specific offering
+     * was requested that is not the current one.
      */
     readonly current: Offering | null;
 }
@@ -501,13 +529,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;
     /**
@@ -524,13 +556,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.
@@ -538,6 +571,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"
 }
 
 /**
@@ -623,6 +680,7 @@ export declare class Purchases {
       /**
        * Fetch the configured offerings for this user. You can configure these
        * in the RevenueCat dashboard.
+       * @param params - The parameters object to customise the offerings fetch. Check {@link GetOfferingsParams}
        */
       getOfferings(params?: GetOfferingsParams): Promise<Offerings>;
       /**
@@ -739,6 +797,7 @@ export declare class Purchases {
 
          /**
           * Extra information that is available in certain types of errors.
+          * @public
           */
          export declare interface PurchasesErrorExtra {
              /**