@revenuecat/purchases-typescript-internal 7.3.3 → 7.4.0

package/dist/customerInfo.d.ts

@@ -1,3 +1,4 @@
+import { VERIFICATION_RESULT } from "./enums";
 /**
  * The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.
  */
@@ -93,6 +94,10 @@ export interface PurchasesEntitlementInfo {
      * UNKNOWN if the purchase has no or an unknown ownership type.
      */
     readonly ownershipType: "FAMILY_SHARED" | "PURCHASED" | "UNKNOWN";
+    /**
+     * If entitlement verification was enabled, the result of that verification. If not, VerificationResult.NOT_REQUESTED
+     */
+    readonly verification: VERIFICATION_RESULT;
 }
 /**
  * Contains all the entitlements associated to the user.
@@ -110,6 +115,10 @@ export interface PurchasesEntitlementInfos {
     readonly active: {
         [key: string]: PurchasesEntitlementInfo;
     };
+    /**
+     * If entitlement verification was enabled, the result of that verification. If not, VerificationResult.NOT_REQUESTED
+     */
+    readonly verification: VERIFICATION_RESULT;
 }
 export interface CustomerInfo {
     /**

package/dist/enums.d.ts

@@ -80,3 +80,53 @@ export declare enum IN_APP_MESSAGE_TYPE {
      */
     GENERIC = 2
 }
+/**
+ * Enum of entitlement verification modes.
+ */
+export declare enum ENTITLEMENT_VERIFICATION_MODE {
+    /**
+     * The SDK will not perform any entitlement verification.
+     */
+    DISABLED = "DISABLED",
+    /**
+       * Enable entitlement verification.
+       *
+       * If verification fails, this will be indicated with [VerificationResult.FAILED] in
+       * the [EntitlementInfos.verification] and [EntitlementInfo.verification] properties but parsing will not fail
+       * (i.e. Entitlements will still be granted).
+       *
+       * This can be useful if you want to handle verification failures to display an error/warning to the user
+       * or to track this situation but still grant access.
+       */
+    INFORMATIONAL = "INFORMATIONAL"
+}
+/**
+ * The result of the verification process. For more details check: http://rev.cat/trusted-entitlements
+ *
+ * This is accomplished by preventing MiTM attacks between the SDK and the RevenueCat server.
+ * With verification enabled, the SDK ensures that the response created by the server was not
+ * modified by a third-party, and the response received is exactly what was sent.
+ *
+ * - Note: Verification is only performed if enabled using PurchasesConfiguration's
+ * entitlementVerificationMode property. This is disabled by default.
+ */
+export declare enum VERIFICATION_RESULT {
+    /**
+     * No verification was done.
+     *
+     * This value is returned when verification is not enabled in PurchasesConfiguration
+     */
+    NOT_REQUESTED = "NOT_REQUESTED",
+    /**
+     * Verification with our server was performed successfully.
+     */
+    VERIFIED = "VERIFIED",
+    /**
+     * Verification failed, possibly due to a MiTM attack.
+     */
+    FAILED = "FAILED",
+    /**
+     * Verification was performed on device.
+     */
+    VERIFIED_ON_DEVICE = "VERIFIED_ON_DEVICE"
+}

package/dist/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IN_APP_MESSAGE_TYPE = exports.LOG_LEVEL = exports.REFUND_REQUEST_STATUS = exports.BILLING_FEATURE = exports.PURCHASE_TYPE = void 0;
+exports.VERIFICATION_RESULT = exports.ENTITLEMENT_VERIFICATION_MODE = exports.IN_APP_MESSAGE_TYPE = exports.LOG_LEVEL = exports.REFUND_REQUEST_STATUS = exports.BILLING_FEATURE = exports.PURCHASE_TYPE = void 0;
 /**
  * @deprecated, use PRODUCT_CATEGORY
  */
@@ -89,3 +89,57 @@ var IN_APP_MESSAGE_TYPE;
      */
     IN_APP_MESSAGE_TYPE[IN_APP_MESSAGE_TYPE["GENERIC"] = 2] = "GENERIC";
 })(IN_APP_MESSAGE_TYPE || (exports.IN_APP_MESSAGE_TYPE = IN_APP_MESSAGE_TYPE = {}));
+/**
+ * Enum of entitlement verification modes.
+ */
+var ENTITLEMENT_VERIFICATION_MODE;
+(function (ENTITLEMENT_VERIFICATION_MODE) {
+    /**
+     * The SDK will not perform any entitlement verification.
+     */
+    ENTITLEMENT_VERIFICATION_MODE["DISABLED"] = "DISABLED";
+    /**
+       * Enable entitlement verification.
+       *
+       * If verification fails, this will be indicated with [VerificationResult.FAILED] in
+       * the [EntitlementInfos.verification] and [EntitlementInfo.verification] properties but parsing will not fail
+       * (i.e. Entitlements will still be granted).
+       *
+       * This can be useful if you want to handle verification failures to display an error/warning to the user
+       * or to track this situation but still grant access.
+       */
+    ENTITLEMENT_VERIFICATION_MODE["INFORMATIONAL"] = "INFORMATIONAL";
+    // Add ENFORCED mode once we're ready to ship it.
+    // ENFORCED = "ENFORCED"
+})(ENTITLEMENT_VERIFICATION_MODE || (exports.ENTITLEMENT_VERIFICATION_MODE = ENTITLEMENT_VERIFICATION_MODE = {}));
+/**
+ * The result of the verification process. For more details check: http://rev.cat/trusted-entitlements
+ *
+ * This is accomplished by preventing MiTM attacks between the SDK and the RevenueCat server.
+ * With verification enabled, the SDK ensures that the response created by the server was not
+ * modified by a third-party, and the response received is exactly what was sent.
+ *
+ * - Note: Verification is only performed if enabled using PurchasesConfiguration's
+ * entitlementVerificationMode property. This is disabled by default.
+ */
+var VERIFICATION_RESULT;
+(function (VERIFICATION_RESULT) {
+    /**
+     * No verification was done.
+     *
+     * This value is returned when verification is not enabled in PurchasesConfiguration
+     */
+    VERIFICATION_RESULT["NOT_REQUESTED"] = "NOT_REQUESTED";
+    /**
+     * Verification with our server was performed successfully.
+     */
+    VERIFICATION_RESULT["VERIFIED"] = "VERIFIED";
+    /**
+     * Verification failed, possibly due to a MiTM attack.
+     */
+    VERIFICATION_RESULT["FAILED"] = "FAILED";
+    /**
+     * Verification was performed on device.
+     */
+    VERIFICATION_RESULT["VERIFIED_ON_DEVICE"] = "VERIFIED_ON_DEVICE";
+})(VERIFICATION_RESULT || (exports.VERIFICATION_RESULT = VERIFICATION_RESULT = {}));

package/dist/purchasesConfiguration.d.ts

@@ -1,3 +1,4 @@
+import { ENTITLEMENT_VERIFICATION_MODE } from "./enums";
 /**
  * Holds parameters to initialize the SDK.
  */
@@ -45,4 +46,9 @@ export interface PurchasesConfiguration {
      * check: https://rev.cat/storekit-message and https://rev.cat/googleplayinappmessaging
      */
     shouldShowInAppMessagesAutomatically?: boolean;
+    /**
+     * Verification strictness levels for [EntitlementInfo].
+     * See https://rev.cat/trusted-entitlements for more info.
+     */
+    entitlementVerificationInfo?: ENTITLEMENT_VERIFICATION_MODE;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revenuecat/purchases-typescript-internal",
   "title": "Purchases typescript internal shared code",
-  "version": "7.3.3",
+  "version": "7.4.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",