@revenuecat/purchases-js 0.6.0 → 0.8.0

package/dist/Purchases.es.d.ts

@@ -171,7 +171,7 @@ export declare enum ErrorCode {
 }
 
 /**
- * Parameters for the {@link Purchases.getOfferings}` method.
+ * Parameters for the {@link Purchases.getOfferings} method.
  * @public
  */
 export declare interface GetOfferingsParams {
@@ -419,6 +419,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;
 }
 
 /**
@@ -427,9 +432,14 @@ export declare interface PresentedOfferingContext {
  */
 export declare interface Price {
     /**
-     * Price in full units of the currency.
+     * Price in cents of the currency.
+     * @deprecated - Use {@link Price.amountMicros} instead.
      */
     readonly amount: number;
+    /**
+     * Price in micro-units of the currency. For example, $9.99 is represented as 9990000.
+     */
+    readonly amountMicros: number;
     /**
      * Returns ISO 4217 currency code for price.
      * For example, if price is specified in British pounds sterling,
@@ -602,11 +612,27 @@ export declare class Purchases {
       * @throws {@link PurchasesError} if the API key or user id are invalid.
           */
       static configure(apiKey: string, appUserId: string, httpConfig?: HttpConfig): Purchases;
+      /**
+       * Loads and caches some optional data in the Purchases SDK.
+       * Currently only fetching branding information. You can call this method
+       * after configuring the SDK to speed up the first call to
+       * {@link Purchases.purchase}.
+       */
+      preload(): Promise<void>;
+      private hasLoadedResources;
       /**
        * Fetch the configured offerings for this user. You can configure these
        * 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.
@@ -685,6 +711,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
@@ -699,10 +729,28 @@ 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.
+          */
+         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