@metamask-previews/subscription-controller 6.0.2-preview-434bd0c → 6.0.2-preview-e9620906a

package/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Expose all public `SubscriptionController` methods through its messenger ([#8219](https://github.com/MetaMask/core/pull/8219))
+  - `SubscriptionController:getSubscriptionsEligibilities`
+  - `SubscriptionController:unCancelSubscription`
+  - `SubscriptionController:submitUserEvent`
+  - `SubscriptionController:assignUserToCohort`
+  - `SubscriptionController:getTokenApproveAmount`
+  - `SubscriptionController:getTokenMinimumBalanceAmount`
+  - `SubscriptionController:clearState`
+  - `SubscriptionController:triggerAccessTokenRefresh`
+  - Corresponding action types are now exported (e.g. `SubscriptionControllerGetPricingAction`)
+
 ## [6.0.2]
 
 ### Changed

package/dist/SubscriptionController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SubscriptionController-method-action-types.cjs.map

package/dist/SubscriptionController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.cjs","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { SubscriptionController } from './SubscriptionController';\n\n/**\n * Gets the pricing information from the subscription service.\n *\n * @returns The pricing information.\n */\nexport type SubscriptionControllerGetPricingAction = {\n  type: `SubscriptionController:getPricing`;\n  handler: SubscriptionController['getPricing'];\n};\n\nexport type SubscriptionControllerGetSubscriptionsAction = {\n  type: `SubscriptionController:getSubscriptions`;\n  handler: SubscriptionController['getSubscriptions'];\n};\n\n/**\n * Get the subscription by product.\n *\n * @param productType - The product type.\n * @returns The subscription.\n */\nexport type SubscriptionControllerGetSubscriptionByProductAction = {\n  type: `SubscriptionController:getSubscriptionByProduct`;\n  handler: SubscriptionController['getSubscriptionByProduct'];\n};\n\n/**\n * Get the subscriptions eligibilities.\n *\n * @param request - Optional request object containing user balance to check cohort eligibility.\n * @returns The subscriptions eligibilities.\n */\nexport type SubscriptionControllerGetSubscriptionsEligibilitiesAction = {\n  type: `SubscriptionController:getSubscriptionsEligibilities`;\n  handler: SubscriptionController['getSubscriptionsEligibilities'];\n};\n\nexport type SubscriptionControllerCancelSubscriptionAction = {\n  type: `SubscriptionController:cancelSubscription`;\n  handler: SubscriptionController['cancelSubscription'];\n};\n\nexport type SubscriptionControllerUnCancelSubscriptionAction = {\n  type: `SubscriptionController:unCancelSubscription`;\n  handler: SubscriptionController['unCancelSubscription'];\n};\n\nexport type SubscriptionControllerStartShieldSubscriptionWithCardAction = {\n  type: `SubscriptionController:startShieldSubscriptionWithCard`;\n  handler: SubscriptionController['startShieldSubscriptionWithCard'];\n};\n\nexport type SubscriptionControllerStartSubscriptionWithCryptoAction = {\n  type: `SubscriptionController:startSubscriptionWithCrypto`;\n  handler: SubscriptionController['startSubscriptionWithCrypto'];\n};\n\n/**\n * Handles shield subscription crypto approval transactions.\n *\n * @param txMeta - The transaction metadata.\n * @param isSponsored - Whether the transaction is sponsored.\n * @param rewardAccountId - The account ID of the reward subscription to link to the shield subscription.\n * @returns void\n */\nexport type SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction =\n  {\n    type: `SubscriptionController:submitShieldSubscriptionCryptoApproval`;\n    handler: SubscriptionController['submitShieldSubscriptionCryptoApproval'];\n  };\n\n/**\n * Get transaction params to create crypto approve transaction for subscription payment\n *\n * @param request - The request object\n * @param request.chainId - The chain ID\n * @param request.tokenAddress - The address of the token\n * @param request.productType - The product type\n * @param request.interval - The interval\n * @returns The crypto approve transaction params\n */\nexport type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {\n  type: `SubscriptionController:getCryptoApproveTransactionParams`;\n  handler: SubscriptionController['getCryptoApproveTransactionParams'];\n};\n\nexport type SubscriptionControllerUpdatePaymentMethodAction = {\n  type: `SubscriptionController:updatePaymentMethod`;\n  handler: SubscriptionController['updatePaymentMethod'];\n};\n\n/**\n * Gets the billing portal URL.\n *\n * @returns The billing portal URL\n */\nexport type SubscriptionControllerGetBillingPortalUrlAction = {\n  type: `SubscriptionController:getBillingPortalUrl`;\n  handler: SubscriptionController['getBillingPortalUrl'];\n};\n\n/**\n * Cache the last selected payment method for a specific product.\n *\n * @param product - The product to cache the payment method for.\n * @param paymentMethod - The payment method to cache.\n * @param paymentMethod.type - The type of the payment method.\n * @param paymentMethod.paymentTokenAddress - The payment token address.\n * @param paymentMethod.plan - The plan of the payment method.\n * @param paymentMethod.product - The product of the payment method.\n */\nexport type SubscriptionControllerCacheLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:cacheLastSelectedPaymentMethod`;\n  handler: SubscriptionController['cacheLastSelectedPaymentMethod'];\n};\n\n/**\n * Clear the last selected payment method for a specific product.\n *\n * @param product - The product to clear the payment method for.\n */\nexport type SubscriptionControllerClearLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:clearLastSelectedPaymentMethod`;\n  handler: SubscriptionController['clearLastSelectedPaymentMethod'];\n};\n\n/**\n * Submit sponsorship intents to the Subscription Service backend.\n *\n * This is intended to be used together with the crypto subscription flow.\n * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.\n *\n * @param request - Request object containing the address and products.\n * @example {\n * address: '0x1234567890123456789012345678901234567890',\n * products: [ProductType.Shield],\n * recurringInterval: RecurringInterval.Month,\n * billingCycles: 1,\n * }\n * @returns resolves to true if the sponsorship is supported and intents were submitted successfully, false otherwise\n */\nexport type SubscriptionControllerSubmitSponsorshipIntentsAction = {\n  type: `SubscriptionController:submitSponsorshipIntents`;\n  handler: SubscriptionController['submitSponsorshipIntents'];\n};\n\n/**\n * Submit a user event from the UI. (e.g. shield modal viewed)\n *\n * @param request - Request object containing the event to submit.\n * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }\n */\nexport type SubscriptionControllerSubmitUserEventAction = {\n  type: `SubscriptionController:submitUserEvent`;\n  handler: SubscriptionController['submitUserEvent'];\n};\n\n/**\n * Assign user to a cohort.\n *\n * @param request - Request object containing the cohort to assign the user to.\n * @example { cohort: 'post_tx' }\n */\nexport type SubscriptionControllerAssignUserToCohortAction = {\n  type: `SubscriptionController:assignUserToCohort`;\n  handler: SubscriptionController['assignUserToCohort'];\n};\n\n/**\n * Link rewards to a subscription.\n *\n * @param request - Request object containing the reward subscription ID.\n * @param request.subscriptionId - The ID of the subscription to link rewards to.\n * @param request.rewardAccountId - The account ID of the reward subscription to link to the subscription.\n * @example { subscriptionId: '1234567890', rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }\n * @returns Resolves when the rewards are linked successfully.\n */\nexport type SubscriptionControllerLinkRewardsAction = {\n  type: `SubscriptionController:linkRewards`;\n  handler: SubscriptionController['linkRewards'];\n};\n\n/**\n * Calculate token approve amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token approve amount\n */\nexport type SubscriptionControllerGetTokenApproveAmountAction = {\n  type: `SubscriptionController:getTokenApproveAmount`;\n  handler: SubscriptionController['getTokenApproveAmount'];\n};\n\n/**\n * Calculate token minimum balance amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token balance amount\n */\nexport type SubscriptionControllerGetTokenMinimumBalanceAmountAction = {\n  type: `SubscriptionController:getTokenMinimumBalanceAmount`;\n  handler: SubscriptionController['getTokenMinimumBalanceAmount'];\n};\n\n/**\n * Clears the subscription state and resets to default values.\n */\nexport type SubscriptionControllerClearStateAction = {\n  type: `SubscriptionController:clearState`;\n  handler: SubscriptionController['clearState'];\n};\n\n/**\n * Triggers an access token refresh.\n */\nexport type SubscriptionControllerTriggerAccessTokenRefreshAction = {\n  type: `SubscriptionController:triggerAccessTokenRefresh`;\n  handler: SubscriptionController['triggerAccessTokenRefresh'];\n};\n\n/**\n * Union of all SubscriptionController action types.\n */\nexport type SubscriptionControllerMethodActions =\n  | SubscriptionControllerGetPricingAction\n  | SubscriptionControllerGetSubscriptionsAction\n  | SubscriptionControllerGetSubscriptionByProductAction\n  | SubscriptionControllerGetSubscriptionsEligibilitiesAction\n  | SubscriptionControllerCancelSubscriptionAction\n  | SubscriptionControllerUnCancelSubscriptionAction\n  | SubscriptionControllerStartShieldSubscriptionWithCardAction\n  | SubscriptionControllerStartSubscriptionWithCryptoAction\n  | SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction\n  | SubscriptionControllerGetCryptoApproveTransactionParamsAction\n  | SubscriptionControllerUpdatePaymentMethodAction\n  | SubscriptionControllerGetBillingPortalUrlAction\n  | SubscriptionControllerCacheLastSelectedPaymentMethodAction\n  | SubscriptionControllerClearLastSelectedPaymentMethodAction\n  | SubscriptionControllerSubmitSponsorshipIntentsAction\n  | SubscriptionControllerSubmitUserEventAction\n  | SubscriptionControllerAssignUserToCohortAction\n  | SubscriptionControllerLinkRewardsAction\n  | SubscriptionControllerGetTokenApproveAmountAction\n  | SubscriptionControllerGetTokenMinimumBalanceAmountAction\n  | SubscriptionControllerClearStateAction\n  | SubscriptionControllerTriggerAccessTokenRefreshAction;\n"]}

package/dist/SubscriptionController-method-action-types.d.cts

@@ -0,0 +1,209 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { SubscriptionController } from "./SubscriptionController.cjs";
+/**
+ * Gets the pricing information from the subscription service.
+ *
+ * @returns The pricing information.
+ */
+export type SubscriptionControllerGetPricingAction = {
+    type: `SubscriptionController:getPricing`;
+    handler: SubscriptionController['getPricing'];
+};
+export type SubscriptionControllerGetSubscriptionsAction = {
+    type: `SubscriptionController:getSubscriptions`;
+    handler: SubscriptionController['getSubscriptions'];
+};
+/**
+ * Get the subscription by product.
+ *
+ * @param productType - The product type.
+ * @returns The subscription.
+ */
+export type SubscriptionControllerGetSubscriptionByProductAction = {
+    type: `SubscriptionController:getSubscriptionByProduct`;
+    handler: SubscriptionController['getSubscriptionByProduct'];
+};
+/**
+ * Get the subscriptions eligibilities.
+ *
+ * @param request - Optional request object containing user balance to check cohort eligibility.
+ * @returns The subscriptions eligibilities.
+ */
+export type SubscriptionControllerGetSubscriptionsEligibilitiesAction = {
+    type: `SubscriptionController:getSubscriptionsEligibilities`;
+    handler: SubscriptionController['getSubscriptionsEligibilities'];
+};
+export type SubscriptionControllerCancelSubscriptionAction = {
+    type: `SubscriptionController:cancelSubscription`;
+    handler: SubscriptionController['cancelSubscription'];
+};
+export type SubscriptionControllerUnCancelSubscriptionAction = {
+    type: `SubscriptionController:unCancelSubscription`;
+    handler: SubscriptionController['unCancelSubscription'];
+};
+export type SubscriptionControllerStartShieldSubscriptionWithCardAction = {
+    type: `SubscriptionController:startShieldSubscriptionWithCard`;
+    handler: SubscriptionController['startShieldSubscriptionWithCard'];
+};
+export type SubscriptionControllerStartSubscriptionWithCryptoAction = {
+    type: `SubscriptionController:startSubscriptionWithCrypto`;
+    handler: SubscriptionController['startSubscriptionWithCrypto'];
+};
+/**
+ * Handles shield subscription crypto approval transactions.
+ *
+ * @param txMeta - The transaction metadata.
+ * @param isSponsored - Whether the transaction is sponsored.
+ * @param rewardAccountId - The account ID of the reward subscription to link to the shield subscription.
+ * @returns void
+ */
+export type SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction = {
+    type: `SubscriptionController:submitShieldSubscriptionCryptoApproval`;
+    handler: SubscriptionController['submitShieldSubscriptionCryptoApproval'];
+};
+/**
+ * Get transaction params to create crypto approve transaction for subscription payment
+ *
+ * @param request - The request object
+ * @param request.chainId - The chain ID
+ * @param request.tokenAddress - The address of the token
+ * @param request.productType - The product type
+ * @param request.interval - The interval
+ * @returns The crypto approve transaction params
+ */
+export type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {
+    type: `SubscriptionController:getCryptoApproveTransactionParams`;
+    handler: SubscriptionController['getCryptoApproveTransactionParams'];
+};
+export type SubscriptionControllerUpdatePaymentMethodAction = {
+    type: `SubscriptionController:updatePaymentMethod`;
+    handler: SubscriptionController['updatePaymentMethod'];
+};
+/**
+ * Gets the billing portal URL.
+ *
+ * @returns The billing portal URL
+ */
+export type SubscriptionControllerGetBillingPortalUrlAction = {
+    type: `SubscriptionController:getBillingPortalUrl`;
+    handler: SubscriptionController['getBillingPortalUrl'];
+};
+/**
+ * Cache the last selected payment method for a specific product.
+ *
+ * @param product - The product to cache the payment method for.
+ * @param paymentMethod - The payment method to cache.
+ * @param paymentMethod.type - The type of the payment method.
+ * @param paymentMethod.paymentTokenAddress - The payment token address.
+ * @param paymentMethod.plan - The plan of the payment method.
+ * @param paymentMethod.product - The product of the payment method.
+ */
+export type SubscriptionControllerCacheLastSelectedPaymentMethodAction = {
+    type: `SubscriptionController:cacheLastSelectedPaymentMethod`;
+    handler: SubscriptionController['cacheLastSelectedPaymentMethod'];
+};
+/**
+ * Clear the last selected payment method for a specific product.
+ *
+ * @param product - The product to clear the payment method for.
+ */
+export type SubscriptionControllerClearLastSelectedPaymentMethodAction = {
+    type: `SubscriptionController:clearLastSelectedPaymentMethod`;
+    handler: SubscriptionController['clearLastSelectedPaymentMethod'];
+};
+/**
+ * Submit sponsorship intents to the Subscription Service backend.
+ *
+ * This is intended to be used together with the crypto subscription flow.
+ * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.
+ *
+ * @param request - Request object containing the address and products.
+ * @example {
+ * address: '0x1234567890123456789012345678901234567890',
+ * products: [ProductType.Shield],
+ * recurringInterval: RecurringInterval.Month,
+ * billingCycles: 1,
+ * }
+ * @returns resolves to true if the sponsorship is supported and intents were submitted successfully, false otherwise
+ */
+export type SubscriptionControllerSubmitSponsorshipIntentsAction = {
+    type: `SubscriptionController:submitSponsorshipIntents`;
+    handler: SubscriptionController['submitSponsorshipIntents'];
+};
+/**
+ * Submit a user event from the UI. (e.g. shield modal viewed)
+ *
+ * @param request - Request object containing the event to submit.
+ * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }
+ */
+export type SubscriptionControllerSubmitUserEventAction = {
+    type: `SubscriptionController:submitUserEvent`;
+    handler: SubscriptionController['submitUserEvent'];
+};
+/**
+ * Assign user to a cohort.
+ *
+ * @param request - Request object containing the cohort to assign the user to.
+ * @example { cohort: 'post_tx' }
+ */
+export type SubscriptionControllerAssignUserToCohortAction = {
+    type: `SubscriptionController:assignUserToCohort`;
+    handler: SubscriptionController['assignUserToCohort'];
+};
+/**
+ * Link rewards to a subscription.
+ *
+ * @param request - Request object containing the reward subscription ID.
+ * @param request.subscriptionId - The ID of the subscription to link rewards to.
+ * @param request.rewardAccountId - The account ID of the reward subscription to link to the subscription.
+ * @example { subscriptionId: '1234567890', rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }
+ * @returns Resolves when the rewards are linked successfully.
+ */
+export type SubscriptionControllerLinkRewardsAction = {
+    type: `SubscriptionController:linkRewards`;
+    handler: SubscriptionController['linkRewards'];
+};
+/**
+ * Calculate token approve amount from price info
+ *
+ * @param price - The price info
+ * @param tokenPaymentInfo - The token price info
+ * @returns The token approve amount
+ */
+export type SubscriptionControllerGetTokenApproveAmountAction = {
+    type: `SubscriptionController:getTokenApproveAmount`;
+    handler: SubscriptionController['getTokenApproveAmount'];
+};
+/**
+ * Calculate token minimum balance amount from price info
+ *
+ * @param price - The price info
+ * @param tokenPaymentInfo - The token price info
+ * @returns The token balance amount
+ */
+export type SubscriptionControllerGetTokenMinimumBalanceAmountAction = {
+    type: `SubscriptionController:getTokenMinimumBalanceAmount`;
+    handler: SubscriptionController['getTokenMinimumBalanceAmount'];
+};
+/**
+ * Clears the subscription state and resets to default values.
+ */
+export type SubscriptionControllerClearStateAction = {
+    type: `SubscriptionController:clearState`;
+    handler: SubscriptionController['clearState'];
+};
+/**
+ * Triggers an access token refresh.
+ */
+export type SubscriptionControllerTriggerAccessTokenRefreshAction = {
+    type: `SubscriptionController:triggerAccessTokenRefresh`;
+    handler: SubscriptionController['triggerAccessTokenRefresh'];
+};
+/**
+ * Union of all SubscriptionController action types.
+ */
+export type SubscriptionControllerMethodActions = SubscriptionControllerGetPricingAction | SubscriptionControllerGetSubscriptionsAction | SubscriptionControllerGetSubscriptionByProductAction | SubscriptionControllerGetSubscriptionsEligibilitiesAction | SubscriptionControllerCancelSubscriptionAction | SubscriptionControllerUnCancelSubscriptionAction | SubscriptionControllerStartShieldSubscriptionWithCardAction | SubscriptionControllerStartSubscriptionWithCryptoAction | SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction | SubscriptionControllerGetCryptoApproveTransactionParamsAction | SubscriptionControllerUpdatePaymentMethodAction | SubscriptionControllerGetBillingPortalUrlAction | SubscriptionControllerCacheLastSelectedPaymentMethodAction | SubscriptionControllerClearLastSelectedPaymentMethodAction | SubscriptionControllerSubmitSponsorshipIntentsAction | SubscriptionControllerSubmitUserEventAction | SubscriptionControllerAssignUserToCohortAction | SubscriptionControllerLinkRewardsAction | SubscriptionControllerGetTokenApproveAmountAction | SubscriptionControllerGetTokenMinimumBalanceAmountAction | SubscriptionControllerClearStateAction | SubscriptionControllerTriggerAccessTokenRefreshAction;
+//# sourceMappingURL=SubscriptionController-method-action-types.d.cts.map

package/dist/SubscriptionController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.d.cts","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,qCAAiC;AAEvE;;;;GAIG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,wDAAwD,CAAC;IAC/D,OAAO,EAAE,sBAAsB,CAAC,iCAAiC,CAAC,CAAC;CACpE,CAAC;AAEF,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;CAChE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kEAAkE,GAC5E;IACE,IAAI,EAAE,+DAA+D,CAAC;IACtE,OAAO,EAAE,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;CAC3E,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wDAAwD,GAAG;IACrE,IAAI,EAAE,qDAAqD,CAAC;IAC5D,OAAO,EAAE,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;CACjE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;CAC9D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,sCAAsC,GACtC,4CAA4C,GAC5C,oDAAoD,GACpD,yDAAyD,GACzD,8CAA8C,GAC9C,gDAAgD,GAChD,2DAA2D,GAC3D,uDAAuD,GACvD,kEAAkE,GAClE,6DAA6D,GAC7D,+CAA+C,GAC/C,+CAA+C,GAC/C,0DAA0D,GAC1D,0DAA0D,GAC1D,oDAAoD,GACpD,2CAA2C,GAC3C,8CAA8C,GAC9C,uCAAuC,GACvC,iDAAiD,GACjD,wDAAwD,GACxD,sCAAsC,GACtC,qDAAqD,CAAC"}

package/dist/SubscriptionController-method-action-types.d.mts

@@ -0,0 +1,209 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { SubscriptionController } from "./SubscriptionController.mjs";
+/**
+ * Gets the pricing information from the subscription service.
+ *
+ * @returns The pricing information.
+ */
+export type SubscriptionControllerGetPricingAction = {
+    type: `SubscriptionController:getPricing`;
+    handler: SubscriptionController['getPricing'];
+};
+export type SubscriptionControllerGetSubscriptionsAction = {
+    type: `SubscriptionController:getSubscriptions`;
+    handler: SubscriptionController['getSubscriptions'];
+};
+/**
+ * Get the subscription by product.
+ *
+ * @param productType - The product type.
+ * @returns The subscription.
+ */
+export type SubscriptionControllerGetSubscriptionByProductAction = {
+    type: `SubscriptionController:getSubscriptionByProduct`;
+    handler: SubscriptionController['getSubscriptionByProduct'];
+};
+/**
+ * Get the subscriptions eligibilities.
+ *
+ * @param request - Optional request object containing user balance to check cohort eligibility.
+ * @returns The subscriptions eligibilities.
+ */
+export type SubscriptionControllerGetSubscriptionsEligibilitiesAction = {
+    type: `SubscriptionController:getSubscriptionsEligibilities`;
+    handler: SubscriptionController['getSubscriptionsEligibilities'];
+};
+export type SubscriptionControllerCancelSubscriptionAction = {
+    type: `SubscriptionController:cancelSubscription`;
+    handler: SubscriptionController['cancelSubscription'];
+};
+export type SubscriptionControllerUnCancelSubscriptionAction = {
+    type: `SubscriptionController:unCancelSubscription`;
+    handler: SubscriptionController['unCancelSubscription'];
+};
+export type SubscriptionControllerStartShieldSubscriptionWithCardAction = {
+    type: `SubscriptionController:startShieldSubscriptionWithCard`;
+    handler: SubscriptionController['startShieldSubscriptionWithCard'];
+};
+export type SubscriptionControllerStartSubscriptionWithCryptoAction = {
+    type: `SubscriptionController:startSubscriptionWithCrypto`;
+    handler: SubscriptionController['startSubscriptionWithCrypto'];
+};
+/**
+ * Handles shield subscription crypto approval transactions.
+ *
+ * @param txMeta - The transaction metadata.
+ * @param isSponsored - Whether the transaction is sponsored.
+ * @param rewardAccountId - The account ID of the reward subscription to link to the shield subscription.
+ * @returns void
+ */
+export type SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction = {
+    type: `SubscriptionController:submitShieldSubscriptionCryptoApproval`;
+    handler: SubscriptionController['submitShieldSubscriptionCryptoApproval'];
+};
+/**
+ * Get transaction params to create crypto approve transaction for subscription payment
+ *
+ * @param request - The request object
+ * @param request.chainId - The chain ID
+ * @param request.tokenAddress - The address of the token
+ * @param request.productType - The product type
+ * @param request.interval - The interval
+ * @returns The crypto approve transaction params
+ */
+export type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {
+    type: `SubscriptionController:getCryptoApproveTransactionParams`;
+    handler: SubscriptionController['getCryptoApproveTransactionParams'];
+};
+export type SubscriptionControllerUpdatePaymentMethodAction = {
+    type: `SubscriptionController:updatePaymentMethod`;
+    handler: SubscriptionController['updatePaymentMethod'];
+};
+/**
+ * Gets the billing portal URL.
+ *
+ * @returns The billing portal URL
+ */
+export type SubscriptionControllerGetBillingPortalUrlAction = {
+    type: `SubscriptionController:getBillingPortalUrl`;
+    handler: SubscriptionController['getBillingPortalUrl'];
+};
+/**
+ * Cache the last selected payment method for a specific product.
+ *
+ * @param product - The product to cache the payment method for.
+ * @param paymentMethod - The payment method to cache.
+ * @param paymentMethod.type - The type of the payment method.
+ * @param paymentMethod.paymentTokenAddress - The payment token address.
+ * @param paymentMethod.plan - The plan of the payment method.
+ * @param paymentMethod.product - The product of the payment method.
+ */
+export type SubscriptionControllerCacheLastSelectedPaymentMethodAction = {
+    type: `SubscriptionController:cacheLastSelectedPaymentMethod`;
+    handler: SubscriptionController['cacheLastSelectedPaymentMethod'];
+};
+/**
+ * Clear the last selected payment method for a specific product.
+ *
+ * @param product - The product to clear the payment method for.
+ */
+export type SubscriptionControllerClearLastSelectedPaymentMethodAction = {
+    type: `SubscriptionController:clearLastSelectedPaymentMethod`;
+    handler: SubscriptionController['clearLastSelectedPaymentMethod'];
+};
+/**
+ * Submit sponsorship intents to the Subscription Service backend.
+ *
+ * This is intended to be used together with the crypto subscription flow.
+ * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.
+ *
+ * @param request - Request object containing the address and products.
+ * @example {
+ * address: '0x1234567890123456789012345678901234567890',
+ * products: [ProductType.Shield],
+ * recurringInterval: RecurringInterval.Month,
+ * billingCycles: 1,
+ * }
+ * @returns resolves to true if the sponsorship is supported and intents were submitted successfully, false otherwise
+ */
+export type SubscriptionControllerSubmitSponsorshipIntentsAction = {
+    type: `SubscriptionController:submitSponsorshipIntents`;
+    handler: SubscriptionController['submitSponsorshipIntents'];
+};
+/**
+ * Submit a user event from the UI. (e.g. shield modal viewed)
+ *
+ * @param request - Request object containing the event to submit.
+ * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }
+ */
+export type SubscriptionControllerSubmitUserEventAction = {
+    type: `SubscriptionController:submitUserEvent`;
+    handler: SubscriptionController['submitUserEvent'];
+};
+/**
+ * Assign user to a cohort.
+ *
+ * @param request - Request object containing the cohort to assign the user to.
+ * @example { cohort: 'post_tx' }
+ */
+export type SubscriptionControllerAssignUserToCohortAction = {
+    type: `SubscriptionController:assignUserToCohort`;
+    handler: SubscriptionController['assignUserToCohort'];
+};
+/**
+ * Link rewards to a subscription.
+ *
+ * @param request - Request object containing the reward subscription ID.
+ * @param request.subscriptionId - The ID of the subscription to link rewards to.
+ * @param request.rewardAccountId - The account ID of the reward subscription to link to the subscription.
+ * @example { subscriptionId: '1234567890', rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }
+ * @returns Resolves when the rewards are linked successfully.
+ */
+export type SubscriptionControllerLinkRewardsAction = {
+    type: `SubscriptionController:linkRewards`;
+    handler: SubscriptionController['linkRewards'];
+};
+/**
+ * Calculate token approve amount from price info
+ *
+ * @param price - The price info
+ * @param tokenPaymentInfo - The token price info
+ * @returns The token approve amount
+ */
+export type SubscriptionControllerGetTokenApproveAmountAction = {
+    type: `SubscriptionController:getTokenApproveAmount`;
+    handler: SubscriptionController['getTokenApproveAmount'];
+};
+/**
+ * Calculate token minimum balance amount from price info
+ *
+ * @param price - The price info
+ * @param tokenPaymentInfo - The token price info
+ * @returns The token balance amount
+ */
+export type SubscriptionControllerGetTokenMinimumBalanceAmountAction = {
+    type: `SubscriptionController:getTokenMinimumBalanceAmount`;
+    handler: SubscriptionController['getTokenMinimumBalanceAmount'];
+};
+/**
+ * Clears the subscription state and resets to default values.
+ */
+export type SubscriptionControllerClearStateAction = {
+    type: `SubscriptionController:clearState`;
+    handler: SubscriptionController['clearState'];
+};
+/**
+ * Triggers an access token refresh.
+ */
+export type SubscriptionControllerTriggerAccessTokenRefreshAction = {
+    type: `SubscriptionController:triggerAccessTokenRefresh`;
+    handler: SubscriptionController['triggerAccessTokenRefresh'];
+};
+/**
+ * Union of all SubscriptionController action types.
+ */
+export type SubscriptionControllerMethodActions = SubscriptionControllerGetPricingAction | SubscriptionControllerGetSubscriptionsAction | SubscriptionControllerGetSubscriptionByProductAction | SubscriptionControllerGetSubscriptionsEligibilitiesAction | SubscriptionControllerCancelSubscriptionAction | SubscriptionControllerUnCancelSubscriptionAction | SubscriptionControllerStartShieldSubscriptionWithCardAction | SubscriptionControllerStartSubscriptionWithCryptoAction | SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction | SubscriptionControllerGetCryptoApproveTransactionParamsAction | SubscriptionControllerUpdatePaymentMethodAction | SubscriptionControllerGetBillingPortalUrlAction | SubscriptionControllerCacheLastSelectedPaymentMethodAction | SubscriptionControllerClearLastSelectedPaymentMethodAction | SubscriptionControllerSubmitSponsorshipIntentsAction | SubscriptionControllerSubmitUserEventAction | SubscriptionControllerAssignUserToCohortAction | SubscriptionControllerLinkRewardsAction | SubscriptionControllerGetTokenApproveAmountAction | SubscriptionControllerGetTokenMinimumBalanceAmountAction | SubscriptionControllerClearStateAction | SubscriptionControllerTriggerAccessTokenRefreshAction;
+//# sourceMappingURL=SubscriptionController-method-action-types.d.mts.map

package/dist/SubscriptionController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.d.mts","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,qCAAiC;AAEvE;;;;GAIG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,wDAAwD,CAAC;IAC/D,OAAO,EAAE,sBAAsB,CAAC,iCAAiC,CAAC,CAAC;CACpE,CAAC;AAEF,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;CAChE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kEAAkE,GAC5E;IACE,IAAI,EAAE,+DAA+D,CAAC;IACtE,OAAO,EAAE,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;CAC3E,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wDAAwD,GAAG;IACrE,IAAI,EAAE,qDAAqD,CAAC;IAC5D,OAAO,EAAE,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;CACjE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;CAC9D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,sCAAsC,GACtC,4CAA4C,GAC5C,oDAAoD,GACpD,yDAAyD,GACzD,8CAA8C,GAC9C,gDAAgD,GAChD,2DAA2D,GAC3D,uDAAuD,GACvD,kEAAkE,GAClE,6DAA6D,GAC7D,+CAA+C,GAC/C,+CAA+C,GAC/C,0DAA0D,GAC1D,0DAA0D,GAC1D,oDAAoD,GACpD,2CAA2C,GAC3C,8CAA8C,GAC9C,uCAAuC,GACvC,iDAAiD,GACjD,wDAAwD,GACxD,sCAAsC,GACtC,qDAAqD,CAAC"}

package/dist/SubscriptionController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=SubscriptionController-method-action-types.mjs.map

package/dist/SubscriptionController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.mjs","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { SubscriptionController } from './SubscriptionController';\n\n/**\n * Gets the pricing information from the subscription service.\n *\n * @returns The pricing information.\n */\nexport type SubscriptionControllerGetPricingAction = {\n  type: `SubscriptionController:getPricing`;\n  handler: SubscriptionController['getPricing'];\n};\n\nexport type SubscriptionControllerGetSubscriptionsAction = {\n  type: `SubscriptionController:getSubscriptions`;\n  handler: SubscriptionController['getSubscriptions'];\n};\n\n/**\n * Get the subscription by product.\n *\n * @param productType - The product type.\n * @returns The subscription.\n */\nexport type SubscriptionControllerGetSubscriptionByProductAction = {\n  type: `SubscriptionController:getSubscriptionByProduct`;\n  handler: SubscriptionController['getSubscriptionByProduct'];\n};\n\n/**\n * Get the subscriptions eligibilities.\n *\n * @param request - Optional request object containing user balance to check cohort eligibility.\n * @returns The subscriptions eligibilities.\n */\nexport type SubscriptionControllerGetSubscriptionsEligibilitiesAction = {\n  type: `SubscriptionController:getSubscriptionsEligibilities`;\n  handler: SubscriptionController['getSubscriptionsEligibilities'];\n};\n\nexport type SubscriptionControllerCancelSubscriptionAction = {\n  type: `SubscriptionController:cancelSubscription`;\n  handler: SubscriptionController['cancelSubscription'];\n};\n\nexport type SubscriptionControllerUnCancelSubscriptionAction = {\n  type: `SubscriptionController:unCancelSubscription`;\n  handler: SubscriptionController['unCancelSubscription'];\n};\n\nexport type SubscriptionControllerStartShieldSubscriptionWithCardAction = {\n  type: `SubscriptionController:startShieldSubscriptionWithCard`;\n  handler: SubscriptionController['startShieldSubscriptionWithCard'];\n};\n\nexport type SubscriptionControllerStartSubscriptionWithCryptoAction = {\n  type: `SubscriptionController:startSubscriptionWithCrypto`;\n  handler: SubscriptionController['startSubscriptionWithCrypto'];\n};\n\n/**\n * Handles shield subscription crypto approval transactions.\n *\n * @param txMeta - The transaction metadata.\n * @param isSponsored - Whether the transaction is sponsored.\n * @param rewardAccountId - The account ID of the reward subscription to link to the shield subscription.\n * @returns void\n */\nexport type SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction =\n  {\n    type: `SubscriptionController:submitShieldSubscriptionCryptoApproval`;\n    handler: SubscriptionController['submitShieldSubscriptionCryptoApproval'];\n  };\n\n/**\n * Get transaction params to create crypto approve transaction for subscription payment\n *\n * @param request - The request object\n * @param request.chainId - The chain ID\n * @param request.tokenAddress - The address of the token\n * @param request.productType - The product type\n * @param request.interval - The interval\n * @returns The crypto approve transaction params\n */\nexport type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {\n  type: `SubscriptionController:getCryptoApproveTransactionParams`;\n  handler: SubscriptionController['getCryptoApproveTransactionParams'];\n};\n\nexport type SubscriptionControllerUpdatePaymentMethodAction = {\n  type: `SubscriptionController:updatePaymentMethod`;\n  handler: SubscriptionController['updatePaymentMethod'];\n};\n\n/**\n * Gets the billing portal URL.\n *\n * @returns The billing portal URL\n */\nexport type SubscriptionControllerGetBillingPortalUrlAction = {\n  type: `SubscriptionController:getBillingPortalUrl`;\n  handler: SubscriptionController['getBillingPortalUrl'];\n};\n\n/**\n * Cache the last selected payment method for a specific product.\n *\n * @param product - The product to cache the payment method for.\n * @param paymentMethod - The payment method to cache.\n * @param paymentMethod.type - The type of the payment method.\n * @param paymentMethod.paymentTokenAddress - The payment token address.\n * @param paymentMethod.plan - The plan of the payment method.\n * @param paymentMethod.product - The product of the payment method.\n */\nexport type SubscriptionControllerCacheLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:cacheLastSelectedPaymentMethod`;\n  handler: SubscriptionController['cacheLastSelectedPaymentMethod'];\n};\n\n/**\n * Clear the last selected payment method for a specific product.\n *\n * @param product - The product to clear the payment method for.\n */\nexport type SubscriptionControllerClearLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:clearLastSelectedPaymentMethod`;\n  handler: SubscriptionController['clearLastSelectedPaymentMethod'];\n};\n\n/**\n * Submit sponsorship intents to the Subscription Service backend.\n *\n * This is intended to be used together with the crypto subscription flow.\n * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.\n *\n * @param request - Request object containing the address and products.\n * @example {\n * address: '0x1234567890123456789012345678901234567890',\n * products: [ProductType.Shield],\n * recurringInterval: RecurringInterval.Month,\n * billingCycles: 1,\n * }\n * @returns resolves to true if the sponsorship is supported and intents were submitted successfully, false otherwise\n */\nexport type SubscriptionControllerSubmitSponsorshipIntentsAction = {\n  type: `SubscriptionController:submitSponsorshipIntents`;\n  handler: SubscriptionController['submitSponsorshipIntents'];\n};\n\n/**\n * Submit a user event from the UI. (e.g. shield modal viewed)\n *\n * @param request - Request object containing the event to submit.\n * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }\n */\nexport type SubscriptionControllerSubmitUserEventAction = {\n  type: `SubscriptionController:submitUserEvent`;\n  handler: SubscriptionController['submitUserEvent'];\n};\n\n/**\n * Assign user to a cohort.\n *\n * @param request - Request object containing the cohort to assign the user to.\n * @example { cohort: 'post_tx' }\n */\nexport type SubscriptionControllerAssignUserToCohortAction = {\n  type: `SubscriptionController:assignUserToCohort`;\n  handler: SubscriptionController['assignUserToCohort'];\n};\n\n/**\n * Link rewards to a subscription.\n *\n * @param request - Request object containing the reward subscription ID.\n * @param request.subscriptionId - The ID of the subscription to link rewards to.\n * @param request.rewardAccountId - The account ID of the reward subscription to link to the subscription.\n * @example { subscriptionId: '1234567890', rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }\n * @returns Resolves when the rewards are linked successfully.\n */\nexport type SubscriptionControllerLinkRewardsAction = {\n  type: `SubscriptionController:linkRewards`;\n  handler: SubscriptionController['linkRewards'];\n};\n\n/**\n * Calculate token approve amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token approve amount\n */\nexport type SubscriptionControllerGetTokenApproveAmountAction = {\n  type: `SubscriptionController:getTokenApproveAmount`;\n  handler: SubscriptionController['getTokenApproveAmount'];\n};\n\n/**\n * Calculate token minimum balance amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token balance amount\n */\nexport type SubscriptionControllerGetTokenMinimumBalanceAmountAction = {\n  type: `SubscriptionController:getTokenMinimumBalanceAmount`;\n  handler: SubscriptionController['getTokenMinimumBalanceAmount'];\n};\n\n/**\n * Clears the subscription state and resets to default values.\n */\nexport type SubscriptionControllerClearStateAction = {\n  type: `SubscriptionController:clearState`;\n  handler: SubscriptionController['clearState'];\n};\n\n/**\n * Triggers an access token refresh.\n */\nexport type SubscriptionControllerTriggerAccessTokenRefreshAction = {\n  type: `SubscriptionController:triggerAccessTokenRefresh`;\n  handler: SubscriptionController['triggerAccessTokenRefresh'];\n};\n\n/**\n * Union of all SubscriptionController action types.\n */\nexport type SubscriptionControllerMethodActions =\n  | SubscriptionControllerGetPricingAction\n  | SubscriptionControllerGetSubscriptionsAction\n  | SubscriptionControllerGetSubscriptionByProductAction\n  | SubscriptionControllerGetSubscriptionsEligibilitiesAction\n  | SubscriptionControllerCancelSubscriptionAction\n  | SubscriptionControllerUnCancelSubscriptionAction\n  | SubscriptionControllerStartShieldSubscriptionWithCardAction\n  | SubscriptionControllerStartSubscriptionWithCryptoAction\n  | SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction\n  | SubscriptionControllerGetCryptoApproveTransactionParamsAction\n  | SubscriptionControllerUpdatePaymentMethodAction\n  | SubscriptionControllerGetBillingPortalUrlAction\n  | SubscriptionControllerCacheLastSelectedPaymentMethodAction\n  | SubscriptionControllerClearLastSelectedPaymentMethodAction\n  | SubscriptionControllerSubmitSponsorshipIntentsAction\n  | SubscriptionControllerSubmitUserEventAction\n  | SubscriptionControllerAssignUserToCohortAction\n  | SubscriptionControllerLinkRewardsAction\n  | SubscriptionControllerGetTokenApproveAmountAction\n  | SubscriptionControllerGetTokenMinimumBalanceAmountAction\n  | SubscriptionControllerClearStateAction\n  | SubscriptionControllerTriggerAccessTokenRefreshAction;\n"]}

package/dist/SubscriptionController.cjs

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _SubscriptionController_instances, _SubscriptionController_subscriptionService, _SubscriptionController_registerMessageHandlers, _SubscriptionController_getSubscriptionPriceAmount, _SubscriptionController_getSubscriptionBalanceAmount, _SubscriptionController_getProductPriceByProductAndPlan, _SubscriptionController_assertValidSubscriptionStateForCryptoApproval, _SubscriptionController_assertIsUserNotSubscribed, _SubscriptionController_assertIsUserSubscribed, _SubscriptionController_assertIsPaymentMethodCrypto, _SubscriptionController_getIsEligibleForTrialedSponsorship, _SubscriptionController_getChainSupportsSponsorship, _SubscriptionController_areTrialedProductsEqual, _SubscriptionController_areSubscriptionsEqual, _SubscriptionController_isSubscriptionEqual, _SubscriptionController_stringifySubscription;
+var _SubscriptionController_instances, _SubscriptionController_subscriptionService, _SubscriptionController_getSubscriptionPriceAmount, _SubscriptionController_getSubscriptionBalanceAmount, _SubscriptionController_getProductPriceByProductAndPlan, _SubscriptionController_assertValidSubscriptionStateForCryptoApproval, _SubscriptionController_assertIsUserNotSubscribed, _SubscriptionController_assertIsUserSubscribed, _SubscriptionController_assertIsPaymentMethodCrypto, _SubscriptionController_getIsEligibleForTrialedSponsorship, _SubscriptionController_getChainSupportsSponsorship, _SubscriptionController_areTrialedProductsEqual, _SubscriptionController_areSubscriptionsEqual, _SubscriptionController_isSubscriptionEqual, _SubscriptionController_stringifySubscription;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubscriptionController = exports.getDefaultSubscriptionControllerState = void 0;
 const polling_controller_1 = require("@metamask/polling-controller");
@@ -81,6 +81,30 @@ const subscriptionControllerMetadata = {
         usedInUi: true,
     },
 };
+const MESSENGER_EXPOSED_METHODS = [
+    'getPricing',
+    'getSubscriptions',
+    'getSubscriptionByProduct',
+    'getSubscriptionsEligibilities',
+    'cancelSubscription',
+    'unCancelSubscription',
+    'startShieldSubscriptionWithCard',
+    'startSubscriptionWithCrypto',
+    'submitShieldSubscriptionCryptoApproval',
+    'getCryptoApproveTransactionParams',
+    'updatePaymentMethod',
+    'getBillingPortalUrl',
+    'cacheLastSelectedPaymentMethod',
+    'clearLastSelectedPaymentMethod',
+    'submitSponsorshipIntents',
+    'submitUserEvent',
+    'assignUserToCohort',
+    'linkRewards',
+    'getTokenApproveAmount',
+    'getTokenMinimumBalanceAmount',
+    'clearState',
+    'triggerAccessTokenRefresh',
+];
 class SubscriptionController extends (0, polling_controller_1.StaticIntervalPollingController)() {
     /**
      * Creates a new SubscriptionController instance.
@@ -105,7 +129,7 @@ class SubscriptionController extends (0, polling_controller_1.StaticIntervalPoll
         _SubscriptionController_subscriptionService.set(this, void 0);
         this.setIntervalLength(pollingInterval);
         __classPrivateFieldSet(this, _SubscriptionController_subscriptionService, subscriptionService, "f");
-        __classPrivateFieldGet(this, _SubscriptionController_instances, "m", _SubscriptionController_registerMessageHandlers).call(this);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
      * Gets the pricing information from the subscription service.
@@ -508,22 +532,7 @@ class SubscriptionController extends (0, polling_controller_1.StaticIntervalPoll
     }
 }
 exports.SubscriptionController = SubscriptionController;
-_SubscriptionController_subscriptionService = new WeakMap(), _SubscriptionController_instances = new WeakSet(), _SubscriptionController_registerMessageHandlers = function _SubscriptionController_registerMessageHandlers() {
-    this.messenger.registerActionHandler('SubscriptionController:getSubscriptions', this.getSubscriptions.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:getSubscriptionByProduct', this.getSubscriptionByProduct.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:cancelSubscription', this.cancelSubscription.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:startShieldSubscriptionWithCard', this.startShieldSubscriptionWithCard.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:getPricing', this.getPricing.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:getCryptoApproveTransactionParams', this.getCryptoApproveTransactionParams.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:startSubscriptionWithCrypto', this.startSubscriptionWithCrypto.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:updatePaymentMethod', this.updatePaymentMethod.bind(this));
-    this.messenger.registerActionHandler('SubscriptionController:getBillingPortalUrl', this.getBillingPortalUrl.bind(this));
-    this.messenger.registerActionHandler(`${constants_1.controllerName}:submitSponsorshipIntents`, this.submitSponsorshipIntents.bind(this));
-    this.messenger.registerActionHandler(`${constants_1.controllerName}:submitShieldSubscriptionCryptoApproval`, this.submitShieldSubscriptionCryptoApproval.bind(this));
-    this.messenger.registerActionHandler(`${constants_1.controllerName}:linkRewards`, this.linkRewards.bind(this));
-    this.messenger.registerActionHandler(`${constants_1.controllerName}:cacheLastSelectedPaymentMethod`, this.cacheLastSelectedPaymentMethod.bind(this));
-    this.messenger.registerActionHandler(`${constants_1.controllerName}:clearLastSelectedPaymentMethod`, this.clearLastSelectedPaymentMethod.bind(this));
-}, _SubscriptionController_getSubscriptionPriceAmount = function _SubscriptionController_getSubscriptionPriceAmount(price) {
+_SubscriptionController_subscriptionService = new WeakMap(), _SubscriptionController_instances = new WeakSet(), _SubscriptionController_getSubscriptionPriceAmount = function _SubscriptionController_getSubscriptionPriceAmount(price) {
     // no need to use BigInt since max unitDecimals are always 2 for price
     const amount = new bignumber_js_1.BigNumber(price.unitAmount)
         .div(10 ** price.unitDecimals)