@revenuecat/purchases-js 0.9.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;
 }
 
 /**
@@ -301,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
@@ -308,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;
 }
@@ -663,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>;
       /**