@revenuecat/purchases-js 1.19.0 → 1.20.0

package/dist/Purchases.es.d.ts

@@ -1,3 +1,44 @@
+import { PaywallData } from '@revenuecat/purchases-ui-js';
+import { UIConfig } from '@revenuecat/purchases-ui-js';
+
+declare enum BackendErrorCode {
+    BackendInvalidPlatform = 7000,
+    BackendInvalidEmail = 7012,
+    BackendStoreProblem = 7101,
+    BackendCannotTransferPurchase = 7102,
+    BackendInvalidReceiptToken = 7103,
+    BackendInvalidAppStoreSharedSecret = 7104,
+    BackendInvalidPaymentModeOrIntroPriceNotProvided = 7105,
+    BackendProductIdForGoogleReceiptNotProvided = 7106,
+    BackendInvalidPlayStoreCredentials = 7107,
+    BackendInternalServerError = 7110,
+    BackendEmptyAppUserId = 7220,
+    BackendInvalidAuthToken = 7224,
+    BackendInvalidAPIKey = 7225,
+    BackendBadRequest = 7226,
+    BackendPlayStoreQuotaExceeded = 7229,
+    BackendPlayStoreInvalidPackageName = 7230,
+    BackendPlayStoreGenericError = 7231,
+    BackendUserIneligibleForPromoOffer = 7232,
+    BackendInvalidAppleSubscriptionKey = 7234,
+    BackendSubscriberNotFound = 7259,
+    BackendInvalidSubscriberAttributes = 7263,
+    BackendInvalidSubscriberAttributesBody = 7264,
+    BackendProductIDsMalformed = 7662,
+    BackendAlreadySubscribedError = 7772,
+    BackendPaymentGatewayGenericError = 7773,
+    BackendOfferNotFound = 7814,
+    BackendNoMXRecordsFound = 7834,
+    BackendInvalidOperationSession = 7877,
+    BackendPurchaseCannotBeCompleted = 7878,
+    BackendEmailIsRequired = 7879,
+    BackendGatewaySetupErrorStripeTaxNotActive = 7898,
+    BackendGatewaySetupErrorInvalidTaxOriginAddress = 7899,
+    BackendGatewaySetupErrorMissingRequiredPermission = 7900,
+    BackendGatewaySetupErrorSandboxModeOnly = 7901,
+    BackendInvalidPaddleAPIKey = 7967
+}
+
 /**
  * @public
  * `BrandingAppearance` defines the appearance settings
@@ -77,6 +118,27 @@ export declare interface CustomerInfo {
     };
 }
 
+/**
+ * Custom translations to be used in the purchase flow.
+ * This class allows you to override the default translations used in the purchase flow.
+ * The main level keys are the locale codes and the values are objects with the same keys as the default translations.
+ * @public
+ * @example
+ * This example will override the default translation for the email step title in the English locale.
+ * ```typescript
+ * const customTranslations = {
+ *  en: {
+ *    "email_entry_page.email_step_title": "Billing email",
+ *   }
+ * }
+ * ```
+ */
+declare type CustomTranslations = {
+    [langKey: string]: {
+        [translationKey in LocalizationKeys]?: string;
+    };
+};
+
 /**
  * This object gives you access to all the information about the status
  * of a user's entitlements.
@@ -209,6 +271,16 @@ export declare enum ErrorCode {
     TestStoreSimulatedPurchaseError = 42
 }
 
+declare interface EventProperties {
+    [key: string]: EventPropertyValue;
+}
+
+declare type EventPropertySingleValue = string | number | boolean;
+
+declare type EventPropertyValue = null | EventPropertySingleValue | Array<EventPropertyValue>;
+
+/* Excluded from this release type: ExpressPurchaseButtonUpdater */
+
 /**
  * Flags used to enable or disable certain features in the sdk.
  * @public
@@ -224,6 +296,8 @@ export declare interface FlagsConfig {
      * @defaultValue true
      */
     collectAnalyticsEvents?: boolean;
+    /* Excluded from this release type: rcSource */
+    /* Excluded from this release type: forceEnableWalletMethods */
 }
 
 /**
@@ -276,6 +350,108 @@ export declare interface IdentifyResult {
     readonly wasCreated: boolean;
 }
 
+declare enum LocalizationKeys {
+    PeriodsWeek = "periods.week",
+    PeriodsMonth = "periods.month",
+    PeriodsYear = "periods.year",
+    PeriodsDay = "periods.day",
+    PeriodsWeekShort = "periods.weekShort",
+    PeriodsMonthShort = "periods.monthShort",
+    PeriodsYearShort = "periods.yearShort",
+    PeriodsDayShort = "periods.dayShort",
+    PeriodsLifetime = "periods.lifetime",
+    PeriodsWeekPlural = "periods.weekPlural",
+    PeriodsMonthPlural = "periods.monthPlural",
+    PeriodsYearPlural = "periods.yearPlural",
+    PeriodsDayPlural = "periods.dayPlural",
+    PeriodsWeekFrequency = "periods.weekFrequency",
+    PeriodsMonthFrequency = "periods.monthFrequency",
+    PeriodsYearFrequency = "periods.yearFrequency",
+    PeriodsDayFrequency = "periods.dayFrequency",
+    PeriodsPerWeekFrequency = "periods.perWeekFrequency",
+    PeriodsPerMonthFrequency = "periods.perMonthFrequency",
+    PeriodsPerYearFrequency = "periods.perYearFrequency",
+    PeriodsPerDayFrequency = "periods.perDayFrequency",
+    PeriodsUnknownFrequency = "periods.unknownFrequency",
+    PeriodsWeekFrequencyPlural = "periods.weekFrequencyPlural",
+    PeriodsMonthFrequencyPlural = "periods.monthFrequencyPlural",
+    PeriodsYearFrequencyPlural = "periods.yearFrequencyPlural",
+    PeriodsDayFrequencyPlural = "periods.dayFrequencyPlural",
+    ProductInfoProductTitle = "product_info.product_title",
+    ProductInfoProductDescription = "product_info.product_description",
+    ProductInfoProductPrice = "product_info.product_price",
+    ProductInfoFreeTrialDuration = "product_info.free_trial_duration",
+    ProductInfoPriceAfterFreeTrial = "product_info.price_after_free_trial",
+    ProductInfoIntroPricePhaseAfterTrial = "product_info.intro_price_phase_after_trial",
+    ProductInfoIntroPricePhasePaidOnce = "product_info.intro_price_phase_paid_once",
+    ProductInfoIntroPricePhase = "product_info.intro_price_phase",
+    ProductInfoPriceAfterIntroPrice = "product_info.price_after_intro_price",
+    ProductInfoAfterTrial = "product_info.after_trial",
+    ProductInfoAfter = "product_info.after",
+    ProductInfoPriceTotalDueToday = "product_info.total_due_today",
+    ProductInfoSubscribeTo = "product_info.subscribe_to",
+    ProductInfoRenewalFrequency = "product_info.renewal_frequency",
+    ProductInfoContinuesUntilCancelled = "product_info.continues_until_cancelled",
+    ProductInfoCancelAnytime = "product_info.cancel_anytime",
+    PaymentEntryPagePaymentStepTitle = "payment_entry_page.payment_step_title",
+    PaymentEntryPageTrialSubscriptionTermsInfo = "payment_entry_page.trial_subscription_terms_info",
+    PaymentEntryPageSubscriptionTermsInfo = "payment_entry_page.subscription_terms_info",
+    PaymentEntryPageOtpTermsInfo = "payment_entry_page.otp_terms_info",
+    PaymentEntryPageTermsLinkLabel = "payment_entry_page.terms_link_label",
+    PaymentEntryPageSubscriptionInfo = "payment_entry_page.subscription_info",
+    PaymentEntryPageButtonPay = "payment_entry_page.button_pay",
+    PaymentEntryPageButtonStartTrial = "payment_entry_page.button_start_trial",
+    PaymentEntryPageButtonWithPrice = "payment_entry_page.button_with_price",
+    PaymentEntryPageButtonPaymentMethod = "payment_entry_page.button_payment_method",
+    PaymentEntryPageExpressCheckoutDivider = "payment_entry_page.express_checkout_divider",
+    SuccessPagePurchaseSuccessful = "success_page.purchase_successful",
+    SuccessPageButtonClose = "success_page.button_close",
+    LoadingPageProcessingPayment = "loading_page.processing_payment",
+    LoadingPageKeepPageOpen = "loading_page.keep_page_open",
+    ErrorPageCloseButtonTitle = "error_page.close_button_title",
+    ErrorPageIfErrorPersists = "error_page.if_error_persists",
+    ErrorPageTroubleAccessing = "error_page.trouble_accessing",
+    ErrorPageErrorTitleAlreadySubscribed = "error_page.error_title_already_subscribed",
+    ErrorPageErrorTitleAlreadyPurchased = "error_page.error_title_already_purchased",
+    ErrorPageErrorTitleOtherErrors = "error_page.error_title_other_errors",
+    ErrorPageErrorTitleStripeTaxNotActive = "error_page.error_title_stripe_tax_not_active",
+    ErrorPageErrorTitleStripeInvalidTaxOriginAddress = "error_page.error_title_stripe_invalid_tax_origin_address",
+    ErrorPageErrorTitleStripeMissingRequiredPermission = "error_page.error_title_stripe_missing_required_permission",
+    ErrorPageErrorMessageAlreadySubscribed = "error_page.error_message_already_subscribed",
+    ErrorPageErrorMessageAlreadyPurchased = "error_page.error_message_already_purchased",
+    ErrorPageErrorMessageMissingEmailError = "error_page.error_message_missing_email_error",
+    ErrorPageErrorMessageInvalidEmailError = "error_page.error_message_invalid_email_error",
+    ErrorPageErrorMessageNetworkError = "error_page.error_message_network_error",
+    ErrorPageErrorMessageErrorChargingPayment = "error_page.error_message_error_charging_payment",
+    ErrorPageErrorMessageErrorSettingUpPurchase = "error_page.error_message_error_setting_up_purchase",
+    ErrorPageErrorMessageUnknownError = "error_page.error_message_unknown_error",
+    ErrorPageErrorMessageInvalidTaxLocation = "error_page.error_message_invalid_tax_location",
+    ErrorPageErrorMessageStripeTaxNotActive = "error_page.error_message_stripe_tax_not_active",
+    ErrorPageErrorMessageStripeInvalidTaxOriginAddress = "error_page.error_message_stripe_invalid_tax_origin_address",
+    ErrorPageErrorMessageStripeMissingRequiredPermission = "error_page.error_message_stripe_missing_required_permission",
+    ErrorPageErrorMessageOnlyInSandbox = "error_page.error_only_in_sandbox",
+    ErrorButtonTryAgain = "error_page.button_try_again",
+    ErrorButtonClose = "error_page.button_close",
+    PaywallVariablesPricePerPeriod = "paywall_variables.price_per_period",
+    PaywallVariablesSubRelativeDiscount = "paywall_variables.sub_relative_discount",
+    PaywallVariablesTotalPriceAndPerMonth = "paywall_variables.total_price_and_per_month",
+    PricingDropdownShowDetails = "pricing_dropdown.show_details",
+    PricingDropdownHideDetails = "pricing_dropdown.hide_details",
+    PricingTotalExcludingTax = "pricing_table.total_excluding_tax",
+    PricingTableTrialEnds = "pricing_table.trial_ends",
+    PricingTableTotalDueToday = "pricing_table.total_due_today",
+    PricingTableTax = "pricing_table.tax",
+    PricingTableEnterBillingAddressToCalculate = "pricing_table.enter_billing_address_to_calculate",
+    PricingTableEnterStateOrPostalCodeToCalculate = "pricing_table.enter_state_or_postal_code_to_calculate",
+    PricingTableEnterPostalCodeToCalculate = "pricing_table.enter_postal_code_to_calculate",
+    NavbarHeaderDetails = "navbar_header.details",
+    NavbarBackButton = "navbar_header.back_button",
+    PriceUpdateTitle = "price_update.title",
+    PriceUpdateBaseMessage = "price_update.base_message",
+    PriceUpdateTrialMessage = "price_update.trial_message",
+    ApplePayFreeTrial = "apple_pay.free_trial"
+}
+
 /**
  * Custom log handler function type. Allows you to handle SDK log messages
  * with your own logging system.
@@ -412,6 +588,8 @@ export declare interface Offering {
      * Weekly package type configured in the RevenueCat dashboard, if available.
      */
     readonly weekly: Package | null;
+    /* Excluded from this release type: paywallComponents */
+    /* Excluded from this release type: uiConfig */
 }
 
 /**
@@ -593,6 +771,8 @@ export declare interface PresentedOfferingContext {
     readonly placementIdentifier: string | null;
 }
 
+/* Excluded from this release type: PresentExpressPurchaseButtonParams */
+
 /**
  * Parameters for the {@link Purchases.presentPaywall} method.
  * @public
@@ -634,6 +814,7 @@ export declare interface PresentPaywallParams {
      * The locale to use for the paywall and the checkout flow.
      */
     readonly selectedLocale?: string;
+    /* Excluded from this release type: useExpressPurchaseButtons */
 }
 
 /**
@@ -817,6 +998,31 @@ export declare enum ProductType {
     NonConsumable = "non_consumable"
 }
 
+declare class PurchaseFlowError extends Error {
+    readonly errorCode: PurchaseFlowErrorCode;
+    readonly underlyingErrorMessage?: string | null | undefined;
+    readonly purchasesErrorCode?: ErrorCode | undefined;
+    readonly extra?: PurchasesErrorExtra | undefined;
+    readonly displayPurchaseFlowErrorCode?: boolean | undefined;
+    constructor(errorCode: PurchaseFlowErrorCode, message?: string, underlyingErrorMessage?: string | null | undefined, purchasesErrorCode?: ErrorCode | undefined, extra?: PurchasesErrorExtra | undefined, displayPurchaseFlowErrorCode?: boolean | undefined);
+    getErrorCode(): number;
+    static fromPurchasesError(e: PurchasesError, defaultFlowErrorCode: PurchaseFlowErrorCode, displayPurchaseFlowErrorCode?: boolean): PurchaseFlowError;
+    static fromBackendErrorCode(backendErrorCode: BackendErrorCode | undefined): PurchaseFlowErrorCode | null;
+}
+
+declare enum PurchaseFlowErrorCode {
+    ErrorSettingUpPurchase = 0,
+    ErrorChargingPayment = 1,
+    UnknownError = 2,
+    NetworkError = 3,
+    MissingEmailError = 4,
+    AlreadyPurchasedError = 5,
+    StripeTaxNotActive = 6,
+    StripeInvalidTaxOriginAddress = 7,
+    StripeMissingRequiredPermission = 8,
+    InvalidPaddleAPIKeyError = 9
+}
+
 /**
  * Metadata that can be passed to the backend when making a purchase.
  * They will propagate to the payment gateway (i.e. Stripe) and to RevenueCat.
@@ -860,6 +1066,7 @@ export declare interface PurchaseParams {
      * The email of the user. If undefined, RevenueCat will ask the customer for their email.
      */
     customerEmail?: string;
+    /* Excluded from this release type: workflowPurchaseContext */
     /**
      * The locale to use for the purchase flow. If not specified, English will be used
      */
@@ -881,6 +1088,9 @@ export declare interface PurchaseParams {
      * Defaults to `false`.
      */
     skipSuccessPage?: boolean;
+    /* Excluded from this release type: brandingAppearanceOverride */
+    /* Excluded from this release type: labelsOverride */
+    /* Excluded from this release type: termsAndConditionsUrl */
 }
 
 /**
@@ -913,6 +1123,18 @@ export declare interface PurchaseResult {
  * @public
  */
 export declare class Purchases {
+    /* Excluded from this release type: _API_KEY */
+    /* Excluded from this release type: _appUserId */
+    /* Excluded from this release type: _brandingInfo */
+    /* Excluded from this release type: _loadingResourcesPromise */
+    /* Excluded from this release type: _flags */
+    /* Excluded from this release type: _context */
+    /* Excluded from this release type: backend */
+    /* Excluded from this release type: purchaseOperationHelper */
+    /* Excluded from this release type: eventsTracker */
+    /* Excluded from this release type: _platformInfo */
+    /* Excluded from this release type: inMemoryCache */
+    /* Excluded from this release type: instance */
     /**
      * Set the log level. Logs of the given level and below will be printed
      * in the console.
@@ -931,6 +1153,7 @@ export declare class Purchases {
      * @experimental
      * */
     static setPlatformInfo(platformInfo: PlatformInfo): void;
+    /* Excluded from this release type: getPlatformInfo */
     /**
      * Get the singleton instance of Purchases. It's preferred to use the instance
      * obtained from the `configure` method when possible.
@@ -968,6 +1191,9 @@ export declare class Purchases {
         * up the first call to {@link Purchases.purchase}.
         */
        preload(): Promise<void>;
+       /* Excluded from this release type: fetchAndCacheBrandingInfo */
+       /* Excluded from this release type: hasLoadedResources */
+       /* Excluded from this release type: __constructor */
        /**
         * Renders an RC Paywall and allows the user to purchase from it using Web Billing.
         * @param paywallParams - The parameters object to customise the paywall render. Check {@link PresentPaywallParams}
@@ -1010,6 +1236,7 @@ export declare class Purchases {
          * @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<PurchaseResult>;
+         /* Excluded from this release type: presentExpressPurchaseButton */
          /**
           * Method to perform a purchase for a given package. You can obtain the
           * package from {@link Purchases.getOfferings}. This method will present the purchase
@@ -1030,6 +1257,9 @@ export declare class Purchases {
           private createCheckoutOnCloseHandler;
           private createCheckoutOnFinishedHandler;
           private createCheckoutOnErrorHandler;
+          /* Excluded from this release type: _isConfiguredWithSimulatedStore */
+          /* Excluded from this release type: _shouldForceEnableWalletMethods */
+          /* Excluded from this release type: _postSimulatedStoreReceipt */
           /**
            * Gets latest available {@link CustomerInfo}.
            * @returns The latest {@link CustomerInfo}.
@@ -1071,6 +1301,7 @@ export declare class Purchases {
                  */
              identifyUser(appUserId: string): Promise<IdentifyResult>;
              private replaceUserId;
+             /* Excluded from this release type: logMissingProductIds */
              /**
               * @returns Whether the SDK is using a sandbox API Key.
               */
@@ -1106,6 +1337,8 @@ export declare class Purchases {
               * Closes the Purchases instance. You should never have to do this normally.
               */
              close(): void;
+             /* Excluded from this release type: _getCustomerInfoForUserId */
+             /* Excluded from this release type: _getVirtualCurrenciesForUserId */
              /**
               * Generates an anonymous app user ID that follows RevenueCat's format.
               * This can be used when you don't have a user identifier system in place.
@@ -1115,6 +1348,7 @@ export declare class Purchases {
               * @public
               */
              static generateRevenueCatAnonymousAppUserId(): string;
+             /* Excluded from this release type: _trackEvent */
             }
 
             /**
@@ -1158,8 +1392,11 @@ export declare class Purchases {
                  * Advanced functionality configuration {@link FlagsConfig}.
                  */
                 flags?: FlagsConfig;
+                /* Excluded from this release type: context */
             }
 
+            /* Excluded from this release type: PurchasesContext */
+
             /**
              * Error class for Purchases SDK. You should handle these errors and react
              * accordingly in your app.
@@ -1180,6 +1417,8 @@ export declare class Purchases {
                  * Contains extra information that is available in certain types of errors.
                  */
                 readonly extra?: PurchasesErrorExtra | undefined;
+                /* Excluded from this release type: getForBackendError */
+                /* Excluded from this release type: getForPurchasesFlowError */
                 constructor(
                 /**
                  * Error code for the error. This is useful to appropriately react to
@@ -1424,6 +1663,8 @@ export declare class Purchases {
                 TenjinId = "$tenjinId"
             }
 
+            declare type SDKEventContextSource = "sdk" | "wpl" | string;
+
             /**
              * The store where the user originally subscribed.
              * @public
@@ -1565,6 +1806,12 @@ export declare class Purchases {
                 readonly revision: number;
             }
 
+            declare interface TrackEventProps {
+                eventName: string;
+                source: SDKEventContextSource;
+                properties?: EventProperties;
+            }
+
             /**
              * Error indicating that the SDK was accessed before it was initialized.
              * @public
@@ -1612,4 +1859,8 @@ export declare class Purchases {
                 readonly serverDescription: string | null;
             }
 
+            /* Excluded from this release type: WorkflowContext */
+
+            /* Excluded from this release type: WorkflowPurchaseContext */
+
             export { }