@revenuecat/purchases-typescript-internal 6.2.0 → 7.0.0

package/dist/customerInfo.d.ts

@@ -52,6 +52,10 @@ export interface PurchasesEntitlementInfo {
      * The product identifier that unlocked this entitlement
      */
     readonly productIdentifier: string;
+    /**
+     * The product plan identifier that unlocked this entitlement. Android subscriptions only, null on consumables and iOS.
+     */
+    readonly productPlanIdentifier: string | null;
     /**
      * False if this entitlement is unlocked via a production purchase
      */

package/dist/enums.d.ts

@@ -59,3 +59,24 @@ export declare enum LOG_LEVEL {
     WARN = "WARN",
     ERROR = "ERROR"
 }
+/**
+ * Enum for in-app message types.
+ * This can be used if you disable automatic in-app message from showing automatically.
+ * Then, you can pass what type of messages you want to show in the `showInAppMessages`
+ * method in Purchases.
+ */
+export declare enum IN_APP_MESSAGE_TYPE {
+    /**
+     * In-app messages to indicate there has been a billing issue charging the user.
+     */
+    BILLING_ISSUE = 0,
+    /**
+     * iOS-only. This message will show if you increase the price of a subscription and
+     * the user needs to opt-in to the increase.
+     */
+    PRICE_INCREASE_CONSENT = 1,
+    /**
+     * iOS-only. StoreKit generic messages.
+     */
+    GENERIC = 2
+}

package/dist/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOG_LEVEL = exports.REFUND_REQUEST_STATUS = exports.BILLING_FEATURE = exports.PURCHASE_TYPE = void 0;
+exports.IN_APP_MESSAGE_TYPE = exports.LOG_LEVEL = exports.REFUND_REQUEST_STATUS = exports.BILLING_FEATURE = exports.PURCHASE_TYPE = void 0;
 /**
  * @deprecated, use PRODUCT_CATEGORY
  */
@@ -66,3 +66,26 @@ var LOG_LEVEL;
     LOG_LEVEL["WARN"] = "WARN";
     LOG_LEVEL["ERROR"] = "ERROR";
 })(LOG_LEVEL || (exports.LOG_LEVEL = LOG_LEVEL = {}));
+/**
+ * Enum for in-app message types.
+ * This can be used if you disable automatic in-app message from showing automatically.
+ * Then, you can pass what type of messages you want to show in the `showInAppMessages`
+ * method in Purchases.
+ */
+var IN_APP_MESSAGE_TYPE;
+(function (IN_APP_MESSAGE_TYPE) {
+    // Make sure the enum values are in sync with those defined in iOS/Android
+    /**
+     * In-app messages to indicate there has been a billing issue charging the user.
+     */
+    IN_APP_MESSAGE_TYPE[IN_APP_MESSAGE_TYPE["BILLING_ISSUE"] = 0] = "BILLING_ISSUE";
+    /**
+     * iOS-only. This message will show if you increase the price of a subscription and
+     * the user needs to opt-in to the increase.
+     */
+    IN_APP_MESSAGE_TYPE[IN_APP_MESSAGE_TYPE["PRICE_INCREASE_CONSENT"] = 1] = "PRICE_INCREASE_CONSENT";
+    /**
+     * iOS-only. StoreKit generic messages.
+     */
+    IN_APP_MESSAGE_TYPE[IN_APP_MESSAGE_TYPE["GENERIC"] = 2] = "GENERIC";
+})(IN_APP_MESSAGE_TYPE || (exports.IN_APP_MESSAGE_TYPE = IN_APP_MESSAGE_TYPE = {}));

package/dist/offerings.d.ts

@@ -94,6 +94,11 @@ export interface PurchasesStoreProduct {
      * Product category.
      */
     readonly productCategory: PRODUCT_CATEGORY | null;
+    /**
+     * The specific type of subscription or one time purchase this product represents.
+     * Important: In iOS, if using StoreKit 1, we cannot determine the type.
+     */
+    readonly productType: PRODUCT_TYPE;
     /**
      * Subscription period, specified in ISO 8601 format. For example,
      * P1W equates to one week, P1M equates to one month,
@@ -130,6 +135,32 @@ export declare enum PRODUCT_CATEGORY {
      */
     UNKNOWN = "UNKNOWN"
 }
+export declare enum PRODUCT_TYPE {
+    /**
+     * A consumable in-app purchase.
+     */
+    CONSUMABLE = "CONSUMABLE",
+    /**
+     * A non-consumable in-app purchase. Only applies to Apple Store products.
+     */
+    NON_CONSUMABLE = "NON_CONSUMABLE",
+    /**
+     * A non-renewing subscription. Only applies to Apple Store products.
+     */
+    NON_RENEWABLE_SUBSCRIPTION = "NON_RENEWABLE_SUBSCRIPTION",
+    /**
+     * An auto-renewable subscription.
+     */
+    AUTO_RENEWABLE_SUBSCRIPTION = "AUTO_RENEWABLE_SUBSCRIPTION",
+    /**
+     * A subscription that is pre-paid. Only applies to Google Play products.
+     */
+    PREPAID_SUBSCRIPTION = "PREPAID_SUBSCRIPTION",
+    /**
+     * Unable to determine product type.
+     */
+    UNKNOWN = "UNKNOWN"
+}
 export interface PurchasesStoreProductDiscount {
     /**
      * Identifier of the discount.
@@ -344,11 +375,6 @@ export declare enum PRORATION_MODE {
      * next recurrence time. The billing cycle stays the same.
      */
     IMMEDIATE_WITHOUT_PRORATION = 3,
-    /**
-     * Replacement takes effect when the old plan expires, and the new price will
-     * be charged at the same time.
-     */
-    DEFERRED = 4,
     /**
      * Replacement takes effect immediately, and the user is charged full price
      * of new plan and is given a full billing cycle of subscription,

package/dist/offerings.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PERIOD_UNIT = exports.OFFER_PAYMENT_MODE = exports.RECURRENCE_MODE = exports.PRORATION_MODE = exports.PRODUCT_CATEGORY = exports.INTRO_ELIGIBILITY_STATUS = exports.PACKAGE_TYPE = void 0;
+exports.PERIOD_UNIT = exports.OFFER_PAYMENT_MODE = exports.RECURRENCE_MODE = exports.PRORATION_MODE = exports.PRODUCT_TYPE = exports.PRODUCT_CATEGORY = exports.INTRO_ELIGIBILITY_STATUS = exports.PACKAGE_TYPE = void 0;
 var PACKAGE_TYPE;
 (function (PACKAGE_TYPE) {
     /**
@@ -74,6 +74,33 @@ var PRODUCT_CATEGORY;
      */
     PRODUCT_CATEGORY["UNKNOWN"] = "UNKNOWN";
 })(PRODUCT_CATEGORY || (exports.PRODUCT_CATEGORY = PRODUCT_CATEGORY = {}));
+var PRODUCT_TYPE;
+(function (PRODUCT_TYPE) {
+    /**
+     * A consumable in-app purchase.
+     */
+    PRODUCT_TYPE["CONSUMABLE"] = "CONSUMABLE";
+    /**
+     * A non-consumable in-app purchase. Only applies to Apple Store products.
+     */
+    PRODUCT_TYPE["NON_CONSUMABLE"] = "NON_CONSUMABLE";
+    /**
+     * A non-renewing subscription. Only applies to Apple Store products.
+     */
+    PRODUCT_TYPE["NON_RENEWABLE_SUBSCRIPTION"] = "NON_RENEWABLE_SUBSCRIPTION";
+    /**
+     * An auto-renewable subscription.
+     */
+    PRODUCT_TYPE["AUTO_RENEWABLE_SUBSCRIPTION"] = "AUTO_RENEWABLE_SUBSCRIPTION";
+    /**
+     * A subscription that is pre-paid. Only applies to Google Play products.
+     */
+    PRODUCT_TYPE["PREPAID_SUBSCRIPTION"] = "PREPAID_SUBSCRIPTION";
+    /**
+     * Unable to determine product type.
+     */
+    PRODUCT_TYPE["UNKNOWN"] = "UNKNOWN";
+})(PRODUCT_TYPE || (exports.PRODUCT_TYPE = PRODUCT_TYPE = {}));
 var PRORATION_MODE;
 (function (PRORATION_MODE) {
     PRORATION_MODE[PRORATION_MODE["UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY"] = 0] = "UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY";
@@ -93,11 +120,6 @@ var PRORATION_MODE;
      * next recurrence time. The billing cycle stays the same.
      */
     PRORATION_MODE[PRORATION_MODE["IMMEDIATE_WITHOUT_PRORATION"] = 3] = "IMMEDIATE_WITHOUT_PRORATION";
-    /**
-     * Replacement takes effect when the old plan expires, and the new price will
-     * be charged at the same time.
-     */
-    PRORATION_MODE[PRORATION_MODE["DEFERRED"] = 4] = "DEFERRED";
     /**
      * Replacement takes effect immediately, and the user is charged full price
      * of new plan and is given a full billing cycle of subscription,

package/dist/purchasesConfiguration.d.ts

@@ -38,4 +38,11 @@ export interface PurchasesConfiguration {
      * An optional boolean. Android only. Required to configure the plugin to be used in the Amazon Appstore.
      */
     useAmazon?: boolean;
+    /**
+     * Whether we should show store in-app messages automatically. Both Google Play and the App Store provide in-app
+     * messages for some situations like billing issues. By default, those messages will be shown automatically.
+     * This allows to disable that behavior, so you can display those messages at your convenience. For more information,
+     * check: https://rev.cat/storekit-message and https://rev.cat/googleplayinappmessaging
+     */
+    shouldShowInAppMessagesAutomatically?: boolean;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revenuecat/purchases-typescript-internal",
   "title": "Purchases typescript internal shared code",
-  "version": "6.2.0",
+  "version": "7.0.0",
   "description": "Typescript code to be used by RevenueCat's hybrid SDKs. Not meant for external usage.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",