@revenuecat/purchases-js 0.2.2 → 0.3.1

package/dist/Purchases.es.d.ts

@@ -341,6 +341,21 @@ export declare enum PackageType {
     Weekly = "$rc_weekly"
 }
 
+/**
+ * Represents a period of time.
+ * @public
+ */
+export declare interface Period {
+    /**
+     * The number of units in the period.
+     */
+    number: number;
+    /**
+     * The unit of time.
+     */
+    unit: PeriodUnit;
+}
+
 /**
  * Supported period types for an entitlement.
  * - "normal" If the entitlement is not under an introductory or trial period.
@@ -350,6 +365,17 @@ export declare enum PackageType {
  */
 export declare type PeriodType = "normal" | "intro" | "trial";
 
+/**
+ * Represents a unit of time.
+ * @public
+ */
+export declare enum PeriodUnit {
+    Year = "year",
+    Month = "month",
+    Week = "week",
+    Day = "day"
+}
+
 /**
  * Price information for a product.
  * @public
@@ -372,6 +398,31 @@ export declare interface Price {
     readonly formattedPrice: string;
 }
 
+/**
+ * Represents the price and duration information for a phase of the purchase option.
+ * @public
+ */
+export declare interface PricingPhase {
+    /**
+     * The duration of the phase in ISO 8601 format.
+     */
+    readonly periodDuration: string | null;
+    /**
+     * The duration of the phase as a {@link Period}.
+     */
+    readonly period: Period | null;
+    /**
+     * The price for the purchase option.
+     * Null in case of trials.
+     */
+    readonly price: Price | null;
+    /**
+     * The number of cycles this option's price repeats.
+     * I.e. 2 subscription cycles, 0 if not applicable.
+     */
+    readonly cycleCount: number;
+}
+
 /**
  * Represents product's listing details.
  * @public
@@ -383,20 +434,80 @@ export declare interface Product {
     readonly identifier: string;
     /**
      * Name of the product.
+     * @deprecated - Use {@link Product.title} instead.
      */
     readonly displayName: string;
     /**
-     * Price of the product.
+     * The title of the product as configured in the RevenueCat dashboard.
+     */
+    readonly title: string;
+    /**
+     * The description of the product as configured in the RevenueCat dashboard.
+     */
+    readonly description: string | null;
+    /**
+     * Price of the product. In the case of subscriptions, this will match the
+     * default option's base phase price.
      */
     readonly currentPrice: Price;
     /**
-     * The period duration for a subscription product.
+     * The period duration for a subscription product. This will match the default
+     * option's base phase period duration.
      */
     readonly normalPeriodDuration: string | null;
     /**
      * The offering ID used to obtain this product.
      */
     readonly presentedOfferingIdentifier: string;
+    /**
+     * 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.
+     *
+     * If retrieved through getOfferings the offers are only the ones the customer is
+     * entitled to.
+     */
+    readonly subscriptionOptions: {
+        [optionId: string]: SubscriptionOption;
+    };
+}
+
+/**
+ * Represents a possible option to purchase a product.
+ * @public
+ */
+export declare interface PurchaseOption {
+    /**
+     * The unique id for a purchase option
+     */
+    readonly id: string;
+}
+
+/**
+ * Parameters used to customise the purchase flow when invoking the `.purchase` method.
+ * @public
+ */
+export declare interface PurchaseParams {
+    /**
+     * The package you want to purchase. Obtained from {@link Purchases.getOfferings}.
+     */
+    rcPackage: Package;
+    /**
+     * The option to be used for this purchase. If not specified or null the default one will be used.
+     */
+    purchaseOption?: PurchaseOption | null;
+    /**
+     * The HTML element where the billing view should be added. If undefined, a new div will be created at the root of the page and appended to the body.
+     */
+    htmlTarget?: HTMLElement;
+    /**
+     * The email of the user. If undefined, RevenueCat will ask the customer for their email.
+     */
+    customerEmail?: string;
 }
 
 /**
@@ -451,87 +562,117 @@ export declare class Purchases {
         * 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.
+        * @deprecated - please use .purchase
         * @param rcPackage - The package you want to purchase. Obtained from {@link Purchases.getOfferings}.
-        * @param customerEmail - The email of the user. If null, RevenueCat will ask the customer for their email.
-        * @param htmlTarget - The HTML element where the billing view should be added. If null, a new div will be created at the root of the page and appended to the body.
-        * @returns The customer info after the purchase is completed successfuly.
+        * @param customerEmail - The email of the user. If undefined, RevenueCat will ask the customer for their email.
+        * @param htmlTarget - The HTML element where the billing view should be added. If undefined, a new div will be created at the root of the page and appended to the body.
+        * @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;
         }>;
         /**
-         * Gets latest available {@link CustomerInfo}.
-         * @returns The latest {@link CustomerInfo}.
-         * @throws {@link PurchasesError} if there is an error while fetching the customer info.
+         * 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.
+         * @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.
              */
-         getCustomerInfo(): Promise<CustomerInfo>;
+         purchase(params: PurchaseParams): Promise<{
+             customerInfo: CustomerInfo;
+         }>;
          /**
-          * Gets the current app user id.
-          */
-         getAppUserId(): string;
+          * Gets latest available {@link CustomerInfo}.
+          * @returns The latest {@link CustomerInfo}.
+          * @throws {@link PurchasesError} if there is an error while fetching the customer info.
+              */
+          getCustomerInfo(): Promise<CustomerInfo>;
+          /**
+           * Gets the current app user id.
+           */
+          getAppUserId(): string;
+          /**
+           * Change the current app user id. Returns the customer info for the new
+           * user id.
+           * @param newAppUserId - The user id to change to.
+           */
+          changeUser(newAppUserId: string): Promise<CustomerInfo>;
+          /**
+           * @returns Whether the SDK is using a sandbox API Key.
+           */
+          isSandbox(): boolean;
+          /**
+           * Closes the Purchases instance. You should never have to do this normally.
+           */
+          close(): void;
+         }
+
          /**
-          * Change the current app user id. Returns the customer info for the new
-          * user id.
-          * @param newAppUserId - The user id to change to.
+          * Error class for Purchases SDK. You should handle these errors and react
+          * accordingly in your app.
+          * @public
           */
-         changeUser(newAppUserId: string): Promise<CustomerInfo>;
+         export declare class PurchasesError extends Error {
+             /**
+              * Error code for the error. This is useful to appropriately react to
+              * different error situations.
+              */
+             readonly errorCode: ErrorCode;
+             /**
+              * Underlying error message. This provides more details on the error and
+              * can be useful for debugging and logging.
+              */
+             readonly underlyingErrorMessage?: string | null | undefined;
+             constructor(
+             /**
+              * Error code for the error. This is useful to appropriately react to
+              * different error situations.
+              */
+             errorCode: ErrorCode, 
+             /**
+              * Message for the error. This is useful for debugging and logging.
+              */
+             message?: string, 
+             /**
+              * Underlying error message. This provides more details on the error and
+              * can be useful for debugging and logging.
+              */
+             underlyingErrorMessage?: string | null | undefined);
+             toString: () => string;
+         }
+
          /**
-          * @returns Whether the SDK is using a sandbox API Key.
+          * The store where the user originally subscribed.
+          * @public
           */
-         isSandbox(): boolean;
+         export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "unknown";
+
          /**
-          * Closes the Purchases instance. You should never have to do this normally.
+          * Represents a possible option to purchase a subscription product.
+          * @public
           */
-         close(): void;
-        }
+         export declare interface SubscriptionOption extends PurchaseOption {
+             /**
+              * The base phase for a SubscriptionOption, represents
+              * the price that the customer will be charged after all the discounts have
+              * been consumed and the period at which it will renew.
+              */
+             readonly base: PricingPhase;
+             /**
+              * The trial information for this subscription option if available.
+              */
+             readonly trial: PricingPhase | null;
+         }
 
-        /**
-         * Error class for Purchases SDK. You should handle these errors and react
-         * accordingly in your app.
-         * @public
-         */
-        export declare class PurchasesError extends Error {
-            /**
-             * Error code for the error. This is useful to appropriately react to
-             * different error situations.
-             */
-            readonly errorCode: ErrorCode;
-            /**
-             * Underlying error message. This provides more details on the error and
-             * can be useful for debugging and logging.
-             */
-            readonly underlyingErrorMessage?: string | null | undefined;
-            constructor(
-            /**
-             * Error code for the error. This is useful to appropriately react to
-             * different error situations.
-             */
-            errorCode: ErrorCode, 
-            /**
-             * Message for the error. This is useful for debugging and logging.
-             */
-            message?: string, 
-            /**
-             * Underlying error message. This provides more details on the error and
-             * can be useful for debugging and logging.
-             */
-            underlyingErrorMessage?: string | null | undefined);
-            toString: () => string;
-        }
-
-        /**
-         * The store where the user originally subscribed.
-         * @public
-         */
-        export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "unknown";
-
-        /**
-         * Error indicating that the SDK was accessed before it was initialized.
-         * @public
-         */
-        export declare class UninitializedPurchasesError extends Error {
-            constructor();
-        }
+         /**
+          * Error indicating that the SDK was accessed before it was initialized.
+          * @public
+          */
+         export declare class UninitializedPurchasesError extends Error {
+             constructor();
+         }
 
-        export { }
+         export { }