@revenuecat/purchases-js 1.0.6 → 1.1.0

package/dist/Purchases.es.d.ts

@@ -67,6 +67,16 @@ export declare interface CustomerInfo {
      * The original App User Id recorded for this user.
      */
     readonly originalAppUserId: string;
+    /**
+     * The list of non-subscription transactions made by the user.
+     */
+    readonly nonSubscriptionTransactions: NonSubscriptionTransaction[];
+    /**
+     * Dictionary of all subscription product identifiers and their subscription info.
+     */
+    readonly subscriptionsByProductIdentifier: {
+        [productId: string]: SubscriptionInfo;
+    };
 }
 
 /**
@@ -111,6 +121,10 @@ export declare interface EntitlementInfo {
      * The product identifier that unlocked this entitlement.
      */
     readonly productIdentifier: string;
+    /**
+     * The base plan identifier that unlocked this entitlement (For Google Play subs only).
+     */
+    readonly productPlanIdentifier: string | null;
     /**
      * The date an unsubscribe was detected. Can be `null`.
      * Note: Entitlement may still be active even if user has unsubscribed.
@@ -132,6 +146,13 @@ export declare interface EntitlementInfo {
      * The last period type this entitlement was in.
      */
     readonly periodType: PeriodType;
+    /**
+     * Use this property to determine whether a purchase was made by the
+     * current user or shared to them by a family member. This can be useful
+     * for onboarding users who have had an entitlement shared with them,
+     * but might not be entirely aware of the benefits they now have.
+     */
+    readonly ownershipType: OwnershipType | null;
 }
 
 /**
@@ -282,6 +303,33 @@ export declare interface NonSubscriptionOption extends PurchaseOption {
     readonly basePrice: Price;
 }
 
+/**
+ * Information that represents a non-subscription purchase made by a user.
+ * @public
+ */
+export declare interface NonSubscriptionTransaction {
+    /**
+     * The unique identifier for the transaction created by RevenueCat.
+     */
+    readonly transactionIdentifier: string;
+    /**
+     * The product identifier.
+     */
+    readonly productIdentifier: string;
+    /**
+     * The date that the store charged the user’s account.
+     */
+    readonly purchaseDate: Date;
+    /**
+     * The unique identifier for the transaction created by the Store.
+     */
+    readonly storeTransactionId: string | null;
+    /**
+     * The {@link Store} where the transaction was made.
+     */
+    readonly store: Store;
+}
+
 /**
  * An offering is a collection of {@link Package} available for the user to purchase.
  * For more info see https://docs.revenuecat.com/docs/entitlements
@@ -374,6 +422,13 @@ export declare interface Offerings {
     readonly current: Offering | null;
 }
 
+/**
+ * The types used to describe whether a transaction was purchased by the user,
+ * or is available to them through Family Sharing.
+ * @public
+ */
+export declare type OwnershipType = "PURCHASED" | "FAMILY_SHARED" | "UNKNOWN";
+
 /**
  * Contains information about the product available for the user to purchase.
  * For more info see https://docs.revenuecat.com/docs/entitlements
@@ -478,6 +533,23 @@ export declare enum PeriodUnit {
     Day = "day"
 }
 
+/**
+ * PlatformInfo is an interface that represents the information about the platform.
+ * Used by RevenueCat Hybrid SDKs to provide information about the platform.
+ * @public
+ * @experimental
+ */
+export declare interface PlatformInfo {
+    /**
+     * The flavor of the SDK.
+     */
+    readonly flavor: string;
+    /**
+     * The version of the hybrid SDK.
+     */
+    readonly version: string;
+}
+
 /**
  * Contains data about the context in which an offering was presented.
  * @public
@@ -548,6 +620,21 @@ export declare interface PricingPhase {
      * I.e. 2 subscription cycles, 0 if not applicable.
      */
     readonly cycleCount: number;
+    /**
+     * The approximated price converted to weekly rate, based on the period information.
+     * Null in case of trials.
+     */
+    readonly pricePerWeek: Price | null;
+    /**
+     * The approximated price converted to monthly rate, based on the period information.
+     * Null in case of trials.
+     */
+    readonly pricePerMonth: Price | null;
+    /**
+     * The approximated price converted to yearly rate, based on the period information.
+     * Null in case of trials.
+     */
+    readonly pricePerYear: Price | null;
 }
 
 /**
@@ -734,6 +821,11 @@ export declare class Purchases {
      * @param logLevel - LogLevel to set.
      */
     static setLogLevel(logLevel: LogLevel): void;
+    /**
+     * Meant to be used by RevenueCat hybrids SDKS only.
+     * @experimental
+     * */
+    static setPlatformInfo(platformInfo: PlatformInfo): void;
     /**
      * Get the singleton instance of Purchases. It's preferred to use the instance
      * obtained from the {@link Purchases.configure} method when possible.
@@ -918,6 +1010,86 @@ export declare class Purchases {
           */
          export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "unknown";
 
+         /**
+          * Subscription purchases of the Customer.
+          * @public
+          */
+         export declare interface SubscriptionInfo {
+             /**
+              * The product identifier.
+              */
+             readonly productIdentifier: string;
+             /**
+              * Date when the last subscription period started.
+              */
+             readonly purchaseDate: Date;
+             /**
+              * Date when this subscription first started. This property does not update with renewals.
+              * This property also does not update for product changes within a subscription group or
+              * re-subscriptions by lapsed subscribers.
+              */
+             readonly originalPurchaseDate: Date | null;
+             /**
+              * Date when the subscription expires/expired
+              */
+             readonly expiresDate: Date | null;
+             /**
+              * Store where the subscription was purchased.
+              */
+             readonly store: Store;
+             /**
+              * Date when RevenueCat detected that auto-renewal was turned off for this subscription.
+              * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
+              */
+             readonly unsubscribeDetectedAt: Date | null;
+             /**
+              * Whether or not the purchase was made in sandbox mode.
+              */
+             readonly isSandbox: boolean;
+             /**
+              * Date when RevenueCat detected any billing issues with this subscription.
+              * If and when the billing issue gets resolved, this field is set to null.
+              * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
+              */
+             readonly billingIssuesDetectedAt: Date | null;
+             /**
+              * Date when any grace period for this subscription expires/expired.
+              * null if the customer has never been in a grace period.
+              */
+             readonly gracePeriodExpiresDate: Date | null;
+             /**
+              * How the Customer received access to this subscription:
+              * - "PURCHASED": The customer bought the subscription.
+              * - "FAMILY_SHARED": The customer has access to the product via their family.
+              */
+             readonly ownershipType: OwnershipType;
+             /**
+              * Type of the current subscription period:
+              * - "normal": The product is in a normal period (default)
+              * - "trial": The product is in a free trial period
+              * - "intro": The product is in an introductory pricing period
+              * - "prepaid": The product is in a prepaid pricing period
+              */
+             readonly periodType: PeriodType;
+             /**
+              * Date when RevenueCat detected a refund of this subscription.
+              */
+             readonly refundedAt: Date | null;
+             /**
+              * The transaction id in the store of the subscription.
+              */
+             readonly storeTransactionId: string | null;
+             /**
+              * Whether the subscription is currently active
+              * (at the time this object was obtained).
+              */
+             readonly isActive: boolean;
+             /**
+              * Whether the subscription will renew at the next billing period.
+              */
+             readonly willRenew: boolean;
+         }
+
          /**
           * Represents a possible option to purchase a subscription product.
           * @public