@metamask-previews/subscription-controller 2.1.0-preview-9fa15fd0 → 3.0.0-preview-55f130d1

package/dist/constants.d.mts

@@ -18,8 +18,11 @@ export declare function getEnvUrls(env: Env): EnvUrlsEntry;
 export declare enum SubscriptionControllerErrorMessage {
     UserAlreadySubscribed = "SubscriptionController - User is already subscribed",
     UserNotSubscribed = "SubscriptionController - User is not subscribed",
-    SubscriptionProductsEmpty = "SubscriptionController - Subscription products array cannot be empty"
+    SubscriptionProductsEmpty = "SubscriptionController - Subscription products array cannot be empty",
+    PaymentTokenAddressAndSymbolRequiredForCrypto = "SubscriptionController - Payment token address and symbol are required for crypto payment",
+    PaymentMethodNotCrypto = "SubscriptionController - Payment method is not crypto"
 }
 export declare const DEFAULT_POLLING_INTERVAL: number;
+export declare const ACTIVE_SUBSCRIPTION_STATUSES: string[];
 export {};
 //# sourceMappingURL=constants.d.mts.map

package/dist/constants.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,2BAA2B,CAAC;AAEvD,oBAAY,GAAG;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED,KAAK,YAAY,GAAG;IAClB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAcF;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,YAAY,CAKjD;AAED,oBAAY,kCAAkC;IAC5C,qBAAqB,wDAAmD;IACxE,iBAAiB,oDAA+C;IAChE,yBAAyB,yEAAoE;CAC9F;AAED,eAAO,MAAM,wBAAwB,QAAiB,CAAC"}
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,cAAc,2BAA2B,CAAC;AAEvD,oBAAY,GAAG;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED,KAAK,YAAY,GAAG;IAClB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAcF;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,YAAY,CAKjD;AAED,oBAAY,kCAAkC;IAC5C,qBAAqB,wDAAmD;IACxE,iBAAiB,oDAA+C;IAChE,yBAAyB,yEAAoE;IAC7F,6CAA6C,8FAAyF;IACtI,sBAAsB,0DAAqD;CAC5E;AAED,eAAO,MAAM,wBAAwB,QAAiB,CAAC;AAEvD,eAAO,MAAM,4BAA4B,UAI5B,CAAC"}

package/dist/constants.mjs

@@ -1,3 +1,4 @@
+import { SUBSCRIPTION_STATUSES } from "./types.mjs";
 export const controllerName = 'SubscriptionController';
 export var Env;
 (function (Env) {
@@ -34,6 +35,13 @@ export var SubscriptionControllerErrorMessage;
     SubscriptionControllerErrorMessage["UserAlreadySubscribed"] = "SubscriptionController - User is already subscribed";
     SubscriptionControllerErrorMessage["UserNotSubscribed"] = "SubscriptionController - User is not subscribed";
     SubscriptionControllerErrorMessage["SubscriptionProductsEmpty"] = "SubscriptionController - Subscription products array cannot be empty";
+    SubscriptionControllerErrorMessage["PaymentTokenAddressAndSymbolRequiredForCrypto"] = "SubscriptionController - Payment token address and symbol are required for crypto payment";
+    SubscriptionControllerErrorMessage["PaymentMethodNotCrypto"] = "SubscriptionController - Payment method is not crypto";
 })(SubscriptionControllerErrorMessage || (SubscriptionControllerErrorMessage = {}));
 export const DEFAULT_POLLING_INTERVAL = 5 * 60 * 1000; // 5 minutes
+export const ACTIVE_SUBSCRIPTION_STATUSES = [
+    SUBSCRIPTION_STATUSES.active,
+    SUBSCRIPTION_STATUSES.trialing,
+    SUBSCRIPTION_STATUSES.provisional,
+];
 //# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEvD,MAAM,CAAN,IAAY,GAIX;AAJD,WAAY,GAAG;IACb,kBAAW,CAAA;IACX,kBAAW,CAAA;IACX,kBAAW,CAAA;AACb,CAAC,EAJW,GAAG,KAAH,GAAG,QAId;AAMD,MAAM,QAAQ,GAA8B;IAC1C,GAAG,EAAE;QACH,kBAAkB,EAAE,6CAA6C;KAClE;IACD,GAAG,EAAE;QACH,kBAAkB,EAAE,6CAA6C;KAClE;IACD,GAAG,EAAE;QACH,kBAAkB,EAAE,yCAAyC;KAC9D;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;KACtD;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,CAAN,IAAY,kCAIX;AAJD,WAAY,kCAAkC;IAC5C,mHAAwE,CAAA;IACxE,2GAAgE,CAAA;IAChE,wIAA6F,CAAA;AAC/F,CAAC,EAJW,kCAAkC,KAAlC,kCAAkC,QAI7C;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAK,CAAC,CAAC,YAAY","sourcesContent":["export const controllerName = 'SubscriptionController';\n\nexport enum Env {\n  DEV = 'dev',\n  UAT = 'uat',\n  PRD = 'prd',\n}\n\ntype EnvUrlsEntry = {\n  subscriptionApiUrl: string;\n};\n\nconst ENV_URLS: Record<Env, EnvUrlsEntry> = {\n  dev: {\n    subscriptionApiUrl: 'https://subscription.dev-api.cx.metamask.io',\n  },\n  uat: {\n    subscriptionApiUrl: 'https://subscription.uat-api.cx.metamask.io',\n  },\n  prd: {\n    subscriptionApiUrl: 'https://subscription.api.cx.metamask.io',\n  },\n};\n\n/**\n * Validates and returns correct environment endpoints\n *\n * @param env - environment field\n * @returns the correct environment url\n * @throws on invalid environment passed\n */\nexport function getEnvUrls(env: Env): EnvUrlsEntry {\n  if (!ENV_URLS[env]) {\n    throw new Error('invalid environment configuration');\n  }\n  return ENV_URLS[env];\n}\n\nexport enum SubscriptionControllerErrorMessage {\n  UserAlreadySubscribed = `${controllerName} - User is already subscribed`,\n  UserNotSubscribed = `${controllerName} - User is not subscribed`,\n  SubscriptionProductsEmpty = `${controllerName} - Subscription products array cannot be empty`,\n}\n\nexport const DEFAULT_POLLING_INTERVAL = 5 * 60 * 1_000; // 5 minutes\n"]}
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,oBAAgB;AAEhD,MAAM,CAAC,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEvD,MAAM,CAAN,IAAY,GAIX;AAJD,WAAY,GAAG;IACb,kBAAW,CAAA;IACX,kBAAW,CAAA;IACX,kBAAW,CAAA;AACb,CAAC,EAJW,GAAG,KAAH,GAAG,QAId;AAMD,MAAM,QAAQ,GAA8B;IAC1C,GAAG,EAAE;QACH,kBAAkB,EAAE,6CAA6C;KAClE;IACD,GAAG,EAAE;QACH,kBAAkB,EAAE,6CAA6C;KAClE;IACD,GAAG,EAAE;QACH,kBAAkB,EAAE,yCAAyC;KAC9D;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;KACtD;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,CAAN,IAAY,kCAMX;AAND,WAAY,kCAAkC;IAC5C,mHAAwE,CAAA;IACxE,2GAAgE,CAAA;IAChE,wIAA6F,CAAA;IAC7F,iLAAsI,CAAA;IACtI,sHAA2E,CAAA;AAC7E,CAAC,EANW,kCAAkC,KAAlC,kCAAkC,QAM7C;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAK,CAAC,CAAC,YAAY;AAEpE,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,qBAAqB,CAAC,MAAM;IAC5B,qBAAqB,CAAC,QAAQ;IAC9B,qBAAqB,CAAC,WAAW;CACtB,CAAC","sourcesContent":["import { SUBSCRIPTION_STATUSES } from './types';\n\nexport const controllerName = 'SubscriptionController';\n\nexport enum Env {\n  DEV = 'dev',\n  UAT = 'uat',\n  PRD = 'prd',\n}\n\ntype EnvUrlsEntry = {\n  subscriptionApiUrl: string;\n};\n\nconst ENV_URLS: Record<Env, EnvUrlsEntry> = {\n  dev: {\n    subscriptionApiUrl: 'https://subscription.dev-api.cx.metamask.io',\n  },\n  uat: {\n    subscriptionApiUrl: 'https://subscription.uat-api.cx.metamask.io',\n  },\n  prd: {\n    subscriptionApiUrl: 'https://subscription.api.cx.metamask.io',\n  },\n};\n\n/**\n * Validates and returns correct environment endpoints\n *\n * @param env - environment field\n * @returns the correct environment url\n * @throws on invalid environment passed\n */\nexport function getEnvUrls(env: Env): EnvUrlsEntry {\n  if (!ENV_URLS[env]) {\n    throw new Error('invalid environment configuration');\n  }\n  return ENV_URLS[env];\n}\n\nexport enum SubscriptionControllerErrorMessage {\n  UserAlreadySubscribed = `${controllerName} - User is already subscribed`,\n  UserNotSubscribed = `${controllerName} - User is not subscribed`,\n  SubscriptionProductsEmpty = `${controllerName} - Subscription products array cannot be empty`,\n  PaymentTokenAddressAndSymbolRequiredForCrypto = `${controllerName} - Payment token address and symbol are required for crypto payment`,\n  PaymentMethodNotCrypto = `${controllerName} - Payment method is not crypto`,\n}\n\nexport const DEFAULT_POLLING_INTERVAL = 5 * 60 * 1_000; // 5 minutes\n\nexport const ACTIVE_SUBSCRIPTION_STATUSES = [\n  SUBSCRIPTION_STATUSES.active,\n  SUBSCRIPTION_STATUSES.trialing,\n  SUBSCRIPTION_STATUSES.provisional,\n] as string[];\n"]}

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAoBA,uEAGkC;AAFhC,gIAAA,sBAAsB,OAAA;AACtB,+IAAA,qCAAqC,OAAA;AAqCvC,qCAOiB;AANf,qHAAA,4BAA4B,OAAA;AAC5B,8GAAA,qBAAqB,OAAA;AACrB,sGAAA,aAAa,OAAA;AACb,4GAAA,mBAAmB,OAAA;AACnB,sGAAA,aAAa,OAAA;AACb,8GAAA,qBAAqB,OAAA;AAEvB,uCAAoD;AAA3C,kHAAA,wBAAwB,OAAA;AACjC,6CAAsE;AAA7D,gGAAA,GAAG,OAAA;AAAE,+HAAA,kCAAkC,OAAA;AAEhD,iEAA4D;AAAnD,0HAAA,mBAAmB,OAAA","sourcesContent":["export type {\n  SubscriptionControllerActions,\n  SubscriptionControllerState,\n  SubscriptionControllerEvents,\n  SubscriptionControllerGetSubscriptionsAction,\n  SubscriptionControllerGetSubscriptionByProductAction,\n  SubscriptionControllerCancelSubscriptionAction,\n  SubscriptionControllerStartShieldSubscriptionWithCardAction,\n  SubscriptionControllerGetPricingAction,\n  SubscriptionControllerGetCryptoApproveTransactionParamsAction,\n  SubscriptionControllerStartSubscriptionWithCryptoAction,\n  SubscriptionControllerGetBillingPortalUrlAction,\n  SubscriptionControllerUpdatePaymentMethodAction,\n  SubscriptionControllerGetStateAction,\n  SubscriptionControllerMessenger,\n  SubscriptionControllerOptions,\n  SubscriptionControllerStateChangeEvent,\n  AllowedActions,\n  AllowedEvents,\n} from './SubscriptionController';\nexport {\n  SubscriptionController,\n  getDefaultSubscriptionControllerState,\n} from './SubscriptionController';\nexport type {\n  Subscription,\n  AuthUtils,\n  ISubscriptionService,\n  StartCryptoSubscriptionRequest,\n  StartCryptoSubscriptionResponse,\n  StartSubscriptionRequest,\n  StartSubscriptionResponse,\n  GetCryptoApproveTransactionRequest,\n  GetCryptoApproveTransactionResponse,\n  SubscriptionCardPaymentMethod,\n  SubscriptionCryptoPaymentMethod,\n  SubscriptionPaymentMethod,\n  SubmitUserEventRequest,\n  SubscriptionEligibility,\n  SubscriptionUserEventType,\n  RecurringInterval,\n  SubscriptionStatus,\n  PaymentType,\n  Product,\n  ProductType,\n  ProductPrice,\n  ProductPricing,\n  TokenPaymentInfo,\n  ChainPaymentInfo,\n  Currency,\n  PricingPaymentMethod,\n  PricingResponse,\n  UpdatePaymentMethodOpts,\n  BillingPortalResponse,\n  CryptoPaymentMethodError,\n  UpdatePaymentMethodCryptoRequest,\n  UpdatePaymentMethodCardRequest,\n  UpdatePaymentMethodCardResponse,\n} from './types';\nexport {\n  CRYPTO_PAYMENT_METHOD_ERRORS,\n  SUBSCRIPTION_STATUSES,\n  PRODUCT_TYPES,\n  RECURRING_INTERVALS,\n  PAYMENT_TYPES,\n  SubscriptionUserEvent,\n} from './types';\nexport { SubscriptionServiceError } from './errors';\nexport { Env, SubscriptionControllerErrorMessage } from './constants';\nexport type { SubscriptionServiceConfig } from './SubscriptionService';\nexport { SubscriptionService } from './SubscriptionService';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAoBA,uEAGkC;AAFhC,gIAAA,sBAAsB,OAAA;AACtB,+IAAA,qCAAqC,OAAA;AAuCvC,qCAOiB;AANf,qHAAA,4BAA4B,OAAA;AAC5B,8GAAA,qBAAqB,OAAA;AACrB,sGAAA,aAAa,OAAA;AACb,4GAAA,mBAAmB,OAAA;AACnB,sGAAA,aAAa,OAAA;AACb,8GAAA,qBAAqB,OAAA;AAEvB,uCAAoD;AAA3C,kHAAA,wBAAwB,OAAA;AACjC,6CAAsE;AAA7D,gGAAA,GAAG,OAAA;AAAE,+HAAA,kCAAkC,OAAA;AAEhD,iEAA4D;AAAnD,0HAAA,mBAAmB,OAAA","sourcesContent":["export type {\n  SubscriptionControllerActions,\n  SubscriptionControllerState,\n  SubscriptionControllerEvents,\n  SubscriptionControllerGetSubscriptionsAction,\n  SubscriptionControllerGetSubscriptionByProductAction,\n  SubscriptionControllerCancelSubscriptionAction,\n  SubscriptionControllerStartShieldSubscriptionWithCardAction,\n  SubscriptionControllerGetPricingAction,\n  SubscriptionControllerGetCryptoApproveTransactionParamsAction,\n  SubscriptionControllerStartSubscriptionWithCryptoAction,\n  SubscriptionControllerGetBillingPortalUrlAction,\n  SubscriptionControllerUpdatePaymentMethodAction,\n  SubscriptionControllerGetStateAction,\n  SubscriptionControllerMessenger,\n  SubscriptionControllerOptions,\n  SubscriptionControllerStateChangeEvent,\n  AllowedActions,\n  AllowedEvents,\n} from './SubscriptionController';\nexport {\n  SubscriptionController,\n  getDefaultSubscriptionControllerState,\n} from './SubscriptionController';\nexport type {\n  Subscription,\n  AuthUtils,\n  ISubscriptionService,\n  StartCryptoSubscriptionRequest,\n  StartCryptoSubscriptionResponse,\n  StartSubscriptionRequest,\n  StartSubscriptionResponse,\n  GetCryptoApproveTransactionRequest,\n  GetCryptoApproveTransactionResponse,\n  SubscriptionCardPaymentMethod,\n  SubscriptionCryptoPaymentMethod,\n  SubscriptionPaymentMethod,\n  SubmitUserEventRequest,\n  SubmitSponsorshipIntentsRequest,\n  SubscriptionEligibility,\n  SubscriptionUserEventType,\n  RecurringInterval,\n  SubscriptionStatus,\n  PaymentType,\n  Product,\n  ProductType,\n  ProductPrice,\n  ProductPricing,\n  TokenPaymentInfo,\n  ChainPaymentInfo,\n  Currency,\n  PricingPaymentMethod,\n  PricingResponse,\n  UpdatePaymentMethodOpts,\n  BillingPortalResponse,\n  CryptoPaymentMethodError,\n  UpdatePaymentMethodCryptoRequest,\n  UpdatePaymentMethodCardRequest,\n  UpdatePaymentMethodCardResponse,\n  CachedLastSelectedPaymentMethod as CachedLastSelectedPaymentMethods,\n} from './types';\nexport {\n  CRYPTO_PAYMENT_METHOD_ERRORS,\n  SUBSCRIPTION_STATUSES,\n  PRODUCT_TYPES,\n  RECURRING_INTERVALS,\n  PAYMENT_TYPES,\n  SubscriptionUserEvent,\n} from './types';\nexport { SubscriptionServiceError } from './errors';\nexport { Env, SubscriptionControllerErrorMessage } from './constants';\nexport type { SubscriptionServiceConfig } from './SubscriptionService';\nexport { SubscriptionService } from './SubscriptionService';\n"]}

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 export type { SubscriptionControllerActions, SubscriptionControllerState, SubscriptionControllerEvents, SubscriptionControllerGetSubscriptionsAction, SubscriptionControllerGetSubscriptionByProductAction, SubscriptionControllerCancelSubscriptionAction, SubscriptionControllerStartShieldSubscriptionWithCardAction, SubscriptionControllerGetPricingAction, SubscriptionControllerGetCryptoApproveTransactionParamsAction, SubscriptionControllerStartSubscriptionWithCryptoAction, SubscriptionControllerGetBillingPortalUrlAction, SubscriptionControllerUpdatePaymentMethodAction, SubscriptionControllerGetStateAction, SubscriptionControllerMessenger, SubscriptionControllerOptions, SubscriptionControllerStateChangeEvent, AllowedActions, AllowedEvents, } from "./SubscriptionController.cjs";
 export { SubscriptionController, getDefaultSubscriptionControllerState, } from "./SubscriptionController.cjs";
-export type { Subscription, AuthUtils, ISubscriptionService, StartCryptoSubscriptionRequest, StartCryptoSubscriptionResponse, StartSubscriptionRequest, StartSubscriptionResponse, GetCryptoApproveTransactionRequest, GetCryptoApproveTransactionResponse, SubscriptionCardPaymentMethod, SubscriptionCryptoPaymentMethod, SubscriptionPaymentMethod, SubmitUserEventRequest, SubscriptionEligibility, SubscriptionUserEventType, RecurringInterval, SubscriptionStatus, PaymentType, Product, ProductType, ProductPrice, ProductPricing, TokenPaymentInfo, ChainPaymentInfo, Currency, PricingPaymentMethod, PricingResponse, UpdatePaymentMethodOpts, BillingPortalResponse, CryptoPaymentMethodError, UpdatePaymentMethodCryptoRequest, UpdatePaymentMethodCardRequest, UpdatePaymentMethodCardResponse, } from "./types.cjs";
+export type { Subscription, AuthUtils, ISubscriptionService, StartCryptoSubscriptionRequest, StartCryptoSubscriptionResponse, StartSubscriptionRequest, StartSubscriptionResponse, GetCryptoApproveTransactionRequest, GetCryptoApproveTransactionResponse, SubscriptionCardPaymentMethod, SubscriptionCryptoPaymentMethod, SubscriptionPaymentMethod, SubmitUserEventRequest, SubmitSponsorshipIntentsRequest, SubscriptionEligibility, SubscriptionUserEventType, RecurringInterval, SubscriptionStatus, PaymentType, Product, ProductType, ProductPrice, ProductPricing, TokenPaymentInfo, ChainPaymentInfo, Currency, PricingPaymentMethod, PricingResponse, UpdatePaymentMethodOpts, BillingPortalResponse, CryptoPaymentMethodError, UpdatePaymentMethodCryptoRequest, UpdatePaymentMethodCardRequest, UpdatePaymentMethodCardResponse, CachedLastSelectedPaymentMethod as CachedLastSelectedPaymentMethods, } from "./types.cjs";
 export { CRYPTO_PAYMENT_METHOD_ERRORS, SUBSCRIPTION_STATUSES, PRODUCT_TYPES, RECURRING_INTERVALS, PAYMENT_TYPES, SubscriptionUserEvent, } from "./types.cjs";
 export { SubscriptionServiceError } from "./errors.cjs";
 export { Env, SubscriptionControllerErrorMessage } from "./constants.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,2BAA2B,EAC3B,4BAA4B,EAC5B,4CAA4C,EAC5C,oDAAoD,EACpD,8CAA8C,EAC9C,2DAA2D,EAC3D,sCAAsC,EACtC,6DAA6D,EAC7D,uDAAuD,EACvD,+CAA+C,EAC/C,+CAA+C,EAC/C,oCAAoC,EACpC,+BAA+B,EAC/B,6BAA6B,EAC7B,sCAAsC,EACtC,cAAc,EACd,aAAa,GACd,qCAAiC;AAClC,OAAO,EACL,sBAAsB,EACtB,qCAAqC,GACtC,qCAAiC;AAClC,YAAY,EACV,YAAY,EACZ,SAAS,EACT,oBAAoB,EACpB,8BAA8B,EAC9B,+BAA+B,EAC/B,wBAAwB,EACxB,yBAAyB,EACzB,kCAAkC,EAClC,mCAAmC,EACnC,6BAA6B,EAC7B,+BAA+B,EAC/B,yBAAyB,EACzB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,OAAO,EACP,WAAW,EACX,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EACR,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,gCAAgC,EAChC,8BAA8B,EAC9B,+BAA+B,GAChC,oBAAgB;AACjB,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,GACtB,oBAAgB;AACjB,OAAO,EAAE,wBAAwB,EAAE,qBAAiB;AACpD,OAAO,EAAE,GAAG,EAAE,kCAAkC,EAAE,wBAAoB;AACtE,YAAY,EAAE,yBAAyB,EAAE,kCAA8B;AACvE,OAAO,EAAE,mBAAmB,EAAE,kCAA8B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,2BAA2B,EAC3B,4BAA4B,EAC5B,4CAA4C,EAC5C,oDAAoD,EACpD,8CAA8C,EAC9C,2DAA2D,EAC3D,sCAAsC,EACtC,6DAA6D,EAC7D,uDAAuD,EACvD,+CAA+C,EAC/C,+CAA+C,EAC/C,oCAAoC,EACpC,+BAA+B,EAC/B,6BAA6B,EAC7B,sCAAsC,EACtC,cAAc,EACd,aAAa,GACd,qCAAiC;AAClC,OAAO,EACL,sBAAsB,EACtB,qCAAqC,GACtC,qCAAiC;AAClC,YAAY,EACV,YAAY,EACZ,SAAS,EACT,oBAAoB,EACpB,8BAA8B,EAC9B,+BAA+B,EAC/B,wBAAwB,EACxB,yBAAyB,EACzB,kCAAkC,EAClC,mCAAmC,EACnC,6BAA6B,EAC7B,+BAA+B,EAC/B,yBAAyB,EACzB,sBAAsB,EACtB,+BAA+B,EAC/B,uBAAuB,EACvB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,OAAO,EACP,WAAW,EACX,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EACR,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,gCAAgC,EAChC,8BAA8B,EAC9B,+BAA+B,EAC/B,+BAA+B,IAAI,gCAAgC,GACpE,oBAAgB;AACjB,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,GACtB,oBAAgB;AACjB,OAAO,EAAE,wBAAwB,EAAE,qBAAiB;AACpD,OAAO,EAAE,GAAG,EAAE,kCAAkC,EAAE,wBAAoB;AACtE,YAAY,EAAE,yBAAyB,EAAE,kCAA8B;AACvE,OAAO,EAAE,mBAAmB,EAAE,kCAA8B"}

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 export type { SubscriptionControllerActions, SubscriptionControllerState, SubscriptionControllerEvents, SubscriptionControllerGetSubscriptionsAction, SubscriptionControllerGetSubscriptionByProductAction, SubscriptionControllerCancelSubscriptionAction, SubscriptionControllerStartShieldSubscriptionWithCardAction, SubscriptionControllerGetPricingAction, SubscriptionControllerGetCryptoApproveTransactionParamsAction, SubscriptionControllerStartSubscriptionWithCryptoAction, SubscriptionControllerGetBillingPortalUrlAction, SubscriptionControllerUpdatePaymentMethodAction, SubscriptionControllerGetStateAction, SubscriptionControllerMessenger, SubscriptionControllerOptions, SubscriptionControllerStateChangeEvent, AllowedActions, AllowedEvents, } from "./SubscriptionController.mjs";
 export { SubscriptionController, getDefaultSubscriptionControllerState, } from "./SubscriptionController.mjs";
-export type { Subscription, AuthUtils, ISubscriptionService, StartCryptoSubscriptionRequest, StartCryptoSubscriptionResponse, StartSubscriptionRequest, StartSubscriptionResponse, GetCryptoApproveTransactionRequest, GetCryptoApproveTransactionResponse, SubscriptionCardPaymentMethod, SubscriptionCryptoPaymentMethod, SubscriptionPaymentMethod, SubmitUserEventRequest, SubscriptionEligibility, SubscriptionUserEventType, RecurringInterval, SubscriptionStatus, PaymentType, Product, ProductType, ProductPrice, ProductPricing, TokenPaymentInfo, ChainPaymentInfo, Currency, PricingPaymentMethod, PricingResponse, UpdatePaymentMethodOpts, BillingPortalResponse, CryptoPaymentMethodError, UpdatePaymentMethodCryptoRequest, UpdatePaymentMethodCardRequest, UpdatePaymentMethodCardResponse, } from "./types.mjs";
+export type { Subscription, AuthUtils, ISubscriptionService, StartCryptoSubscriptionRequest, StartCryptoSubscriptionResponse, StartSubscriptionRequest, StartSubscriptionResponse, GetCryptoApproveTransactionRequest, GetCryptoApproveTransactionResponse, SubscriptionCardPaymentMethod, SubscriptionCryptoPaymentMethod, SubscriptionPaymentMethod, SubmitUserEventRequest, SubmitSponsorshipIntentsRequest, SubscriptionEligibility, SubscriptionUserEventType, RecurringInterval, SubscriptionStatus, PaymentType, Product, ProductType, ProductPrice, ProductPricing, TokenPaymentInfo, ChainPaymentInfo, Currency, PricingPaymentMethod, PricingResponse, UpdatePaymentMethodOpts, BillingPortalResponse, CryptoPaymentMethodError, UpdatePaymentMethodCryptoRequest, UpdatePaymentMethodCardRequest, UpdatePaymentMethodCardResponse, CachedLastSelectedPaymentMethod as CachedLastSelectedPaymentMethods, } from "./types.mjs";
 export { CRYPTO_PAYMENT_METHOD_ERRORS, SUBSCRIPTION_STATUSES, PRODUCT_TYPES, RECURRING_INTERVALS, PAYMENT_TYPES, SubscriptionUserEvent, } from "./types.mjs";
 export { SubscriptionServiceError } from "./errors.mjs";
 export { Env, SubscriptionControllerErrorMessage } from "./constants.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,2BAA2B,EAC3B,4BAA4B,EAC5B,4CAA4C,EAC5C,oDAAoD,EACpD,8CAA8C,EAC9C,2DAA2D,EAC3D,sCAAsC,EACtC,6DAA6D,EAC7D,uDAAuD,EACvD,+CAA+C,EAC/C,+CAA+C,EAC/C,oCAAoC,EACpC,+BAA+B,EAC/B,6BAA6B,EAC7B,sCAAsC,EACtC,cAAc,EACd,aAAa,GACd,qCAAiC;AAClC,OAAO,EACL,sBAAsB,EACtB,qCAAqC,GACtC,qCAAiC;AAClC,YAAY,EACV,YAAY,EACZ,SAAS,EACT,oBAAoB,EACpB,8BAA8B,EAC9B,+BAA+B,EAC/B,wBAAwB,EACxB,yBAAyB,EACzB,kCAAkC,EAClC,mCAAmC,EACnC,6BAA6B,EAC7B,+BAA+B,EAC/B,yBAAyB,EACzB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,OAAO,EACP,WAAW,EACX,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EACR,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,gCAAgC,EAChC,8BAA8B,EAC9B,+BAA+B,GAChC,oBAAgB;AACjB,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,GACtB,oBAAgB;AACjB,OAAO,EAAE,wBAAwB,EAAE,qBAAiB;AACpD,OAAO,EAAE,GAAG,EAAE,kCAAkC,EAAE,wBAAoB;AACtE,YAAY,EAAE,yBAAyB,EAAE,kCAA8B;AACvE,OAAO,EAAE,mBAAmB,EAAE,kCAA8B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,2BAA2B,EAC3B,4BAA4B,EAC5B,4CAA4C,EAC5C,oDAAoD,EACpD,8CAA8C,EAC9C,2DAA2D,EAC3D,sCAAsC,EACtC,6DAA6D,EAC7D,uDAAuD,EACvD,+CAA+C,EAC/C,+CAA+C,EAC/C,oCAAoC,EACpC,+BAA+B,EAC/B,6BAA6B,EAC7B,sCAAsC,EACtC,cAAc,EACd,aAAa,GACd,qCAAiC;AAClC,OAAO,EACL,sBAAsB,EACtB,qCAAqC,GACtC,qCAAiC;AAClC,YAAY,EACV,YAAY,EACZ,SAAS,EACT,oBAAoB,EACpB,8BAA8B,EAC9B,+BAA+B,EAC/B,wBAAwB,EACxB,yBAAyB,EACzB,kCAAkC,EAClC,mCAAmC,EACnC,6BAA6B,EAC7B,+BAA+B,EAC/B,yBAAyB,EACzB,sBAAsB,EACtB,+BAA+B,EAC/B,uBAAuB,EACvB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,OAAO,EACP,WAAW,EACX,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EACR,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,gCAAgC,EAChC,8BAA8B,EAC9B,+BAA+B,EAC/B,+BAA+B,IAAI,gCAAgC,GACpE,oBAAgB;AACjB,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,GACtB,oBAAgB;AACjB,OAAO,EAAE,wBAAwB,EAAE,qBAAiB;AACpD,OAAO,EAAE,GAAG,EAAE,kCAAkC,EAAE,wBAAoB;AACtE,YAAY,EAAE,yBAAyB,EAAE,kCAA8B;AACvE,OAAO,EAAE,mBAAmB,EAAE,kCAA8B"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,sBAAsB,EACtB,qCAAqC,EACtC,qCAAiC;AAoClC,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACtB,oBAAgB;AACjB,OAAO,EAAE,wBAAwB,EAAE,qBAAiB;AACpD,OAAO,EAAE,GAAG,EAAE,kCAAkC,EAAE,wBAAoB;AAEtE,OAAO,EAAE,mBAAmB,EAAE,kCAA8B","sourcesContent":["export type {\n  SubscriptionControllerActions,\n  SubscriptionControllerState,\n  SubscriptionControllerEvents,\n  SubscriptionControllerGetSubscriptionsAction,\n  SubscriptionControllerGetSubscriptionByProductAction,\n  SubscriptionControllerCancelSubscriptionAction,\n  SubscriptionControllerStartShieldSubscriptionWithCardAction,\n  SubscriptionControllerGetPricingAction,\n  SubscriptionControllerGetCryptoApproveTransactionParamsAction,\n  SubscriptionControllerStartSubscriptionWithCryptoAction,\n  SubscriptionControllerGetBillingPortalUrlAction,\n  SubscriptionControllerUpdatePaymentMethodAction,\n  SubscriptionControllerGetStateAction,\n  SubscriptionControllerMessenger,\n  SubscriptionControllerOptions,\n  SubscriptionControllerStateChangeEvent,\n  AllowedActions,\n  AllowedEvents,\n} from './SubscriptionController';\nexport {\n  SubscriptionController,\n  getDefaultSubscriptionControllerState,\n} from './SubscriptionController';\nexport type {\n  Subscription,\n  AuthUtils,\n  ISubscriptionService,\n  StartCryptoSubscriptionRequest,\n  StartCryptoSubscriptionResponse,\n  StartSubscriptionRequest,\n  StartSubscriptionResponse,\n  GetCryptoApproveTransactionRequest,\n  GetCryptoApproveTransactionResponse,\n  SubscriptionCardPaymentMethod,\n  SubscriptionCryptoPaymentMethod,\n  SubscriptionPaymentMethod,\n  SubmitUserEventRequest,\n  SubscriptionEligibility,\n  SubscriptionUserEventType,\n  RecurringInterval,\n  SubscriptionStatus,\n  PaymentType,\n  Product,\n  ProductType,\n  ProductPrice,\n  ProductPricing,\n  TokenPaymentInfo,\n  ChainPaymentInfo,\n  Currency,\n  PricingPaymentMethod,\n  PricingResponse,\n  UpdatePaymentMethodOpts,\n  BillingPortalResponse,\n  CryptoPaymentMethodError,\n  UpdatePaymentMethodCryptoRequest,\n  UpdatePaymentMethodCardRequest,\n  UpdatePaymentMethodCardResponse,\n} from './types';\nexport {\n  CRYPTO_PAYMENT_METHOD_ERRORS,\n  SUBSCRIPTION_STATUSES,\n  PRODUCT_TYPES,\n  RECURRING_INTERVALS,\n  PAYMENT_TYPES,\n  SubscriptionUserEvent,\n} from './types';\nexport { SubscriptionServiceError } from './errors';\nexport { Env, SubscriptionControllerErrorMessage } from './constants';\nexport type { SubscriptionServiceConfig } from './SubscriptionService';\nexport { SubscriptionService } from './SubscriptionService';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,sBAAsB,EACtB,qCAAqC,EACtC,qCAAiC;AAsClC,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACtB,oBAAgB;AACjB,OAAO,EAAE,wBAAwB,EAAE,qBAAiB;AACpD,OAAO,EAAE,GAAG,EAAE,kCAAkC,EAAE,wBAAoB;AAEtE,OAAO,EAAE,mBAAmB,EAAE,kCAA8B","sourcesContent":["export type {\n  SubscriptionControllerActions,\n  SubscriptionControllerState,\n  SubscriptionControllerEvents,\n  SubscriptionControllerGetSubscriptionsAction,\n  SubscriptionControllerGetSubscriptionByProductAction,\n  SubscriptionControllerCancelSubscriptionAction,\n  SubscriptionControllerStartShieldSubscriptionWithCardAction,\n  SubscriptionControllerGetPricingAction,\n  SubscriptionControllerGetCryptoApproveTransactionParamsAction,\n  SubscriptionControllerStartSubscriptionWithCryptoAction,\n  SubscriptionControllerGetBillingPortalUrlAction,\n  SubscriptionControllerUpdatePaymentMethodAction,\n  SubscriptionControllerGetStateAction,\n  SubscriptionControllerMessenger,\n  SubscriptionControllerOptions,\n  SubscriptionControllerStateChangeEvent,\n  AllowedActions,\n  AllowedEvents,\n} from './SubscriptionController';\nexport {\n  SubscriptionController,\n  getDefaultSubscriptionControllerState,\n} from './SubscriptionController';\nexport type {\n  Subscription,\n  AuthUtils,\n  ISubscriptionService,\n  StartCryptoSubscriptionRequest,\n  StartCryptoSubscriptionResponse,\n  StartSubscriptionRequest,\n  StartSubscriptionResponse,\n  GetCryptoApproveTransactionRequest,\n  GetCryptoApproveTransactionResponse,\n  SubscriptionCardPaymentMethod,\n  SubscriptionCryptoPaymentMethod,\n  SubscriptionPaymentMethod,\n  SubmitUserEventRequest,\n  SubmitSponsorshipIntentsRequest,\n  SubscriptionEligibility,\n  SubscriptionUserEventType,\n  RecurringInterval,\n  SubscriptionStatus,\n  PaymentType,\n  Product,\n  ProductType,\n  ProductPrice,\n  ProductPricing,\n  TokenPaymentInfo,\n  ChainPaymentInfo,\n  Currency,\n  PricingPaymentMethod,\n  PricingResponse,\n  UpdatePaymentMethodOpts,\n  BillingPortalResponse,\n  CryptoPaymentMethodError,\n  UpdatePaymentMethodCryptoRequest,\n  UpdatePaymentMethodCardRequest,\n  UpdatePaymentMethodCardResponse,\n  CachedLastSelectedPaymentMethod as CachedLastSelectedPaymentMethods,\n} from './types';\nexport {\n  CRYPTO_PAYMENT_METHOD_ERRORS,\n  SUBSCRIPTION_STATUSES,\n  PRODUCT_TYPES,\n  RECURRING_INTERVALS,\n  PAYMENT_TYPES,\n  SubscriptionUserEvent,\n} from './types';\nexport { SubscriptionServiceError } from './errors';\nexport { Env, SubscriptionControllerErrorMessage } from './constants';\nexport type { SubscriptionServiceConfig } from './SubscriptionService';\nexport { SubscriptionService } from './SubscriptionService';\n"]}

package/dist/types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG;IAC3B,MAAM,EAAE,QAAQ;CACR,CAAC;AAIE,QAAA,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAIE,QAAA,mBAAmB,GAAG;IACjC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKE,QAAA,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,gBAAgB;IAChB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB;IACjB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,QAAQ;IAChB,mBAAmB;IACnB,QAAQ,EAAE,UAAU;IACpB,gBAAgB;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AAKE,QAAA,4BAA4B,GAAG;IAC1C,4BAA4B,EAAE,8BAA8B;IAC5D,6BAA6B,EAAE,+BAA+B;IAC9D,sDAAsD,EACpD,wDAAwD;IAC1D,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAoLE,QAAA,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;CAC3C,CAAC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nexport const PRODUCT_TYPES = {\n  SHIELD: 'shield',\n} as const;\n\nexport type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];\n\nexport const PAYMENT_TYPES = {\n  byCard: 'card',\n  byCrypto: 'crypto',\n} as const;\n\nexport type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];\n\nexport const RECURRING_INTERVALS = {\n  month: 'month',\n  year: 'year',\n} as const;\n\nexport type RecurringInterval =\n  (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];\n\nexport const SUBSCRIPTION_STATUSES = {\n  // Initial states\n  incomplete: 'incomplete',\n  incompleteExpired: 'incomplete_expired',\n  // Active states\n  provisional: 'provisional',\n  trialing: 'trialing',\n  active: 'active',\n  // Payment issues\n  pastDue: 'past_due',\n  unpaid: 'unpaid',\n  // Cancelled states\n  canceled: 'canceled',\n  // Paused states\n  paused: 'paused',\n} as const;\n\nexport type SubscriptionStatus =\n  (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];\n\nexport const CRYPTO_PAYMENT_METHOD_ERRORS = {\n  APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',\n  APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',\n  APPROVAL_TRANSACTION_MAX_VERIFICATION_ATTEMPTS_REACHED:\n    'approval_transaction_max_verification_attempts_reached',\n  INSUFFICIENT_BALANCE: 'insufficient_balance',\n  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',\n} as const;\n\nexport type CryptoPaymentMethodError =\n  (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];\n\n/** only usd for now */\nexport type Currency = 'usd';\n\nexport type Product = {\n  name: ProductType;\n  currency: Currency;\n  unitAmount: number;\n  unitDecimals: number;\n};\n\n// state\nexport type Subscription = {\n  id: string;\n  products: Product[];\n  currentPeriodStart: string; // ISO 8601\n  currentPeriodEnd: string; // ISO 8601\n  /** is subscription scheduled for cancellation */\n  cancelAtPeriodEnd?: boolean;\n  status: SubscriptionStatus;\n  interval: RecurringInterval;\n  paymentMethod: SubscriptionPaymentMethod;\n  trialPeriodDays?: number;\n  trialStart?: string; // ISO 8601\n  trialEnd?: string; // ISO 8601\n  /** Crypto payment only: next billing cycle date (e.g after 12 months) */\n  endDate?: string; // ISO 8601\n  billingCycles?: number;\n};\n\nexport type SubscriptionCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  card: {\n    brand: string;\n    /** display brand account for dual brand card */\n    displayBrand: string;\n    last4: string;\n  };\n};\n\nexport type SubscriptionCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  crypto: {\n    payerAddress: Hex;\n    chainId: Hex;\n    tokenSymbol: string;\n    error?: CryptoPaymentMethodError;\n  };\n};\n\nexport type SubscriptionPaymentMethod =\n  | SubscriptionCardPaymentMethod\n  | SubscriptionCryptoPaymentMethod;\n\nexport type GetSubscriptionsResponse = {\n  customerId?: string;\n  subscriptions: Subscription[];\n  trialedProducts: ProductType[];\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type StartSubscriptionResponse = {\n  checkoutSessionUrl: string;\n};\n\nexport type StartCryptoSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n  chainId: Hex;\n  payerAddress: Hex;\n  /**\n   * e.g. \"USDC\"\n   */\n  tokenSymbol: string;\n  rawTransaction: Hex;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\nexport type AuthUtils = {\n  getAccessToken: () => Promise<string>;\n};\n\nexport type ProductPrice = {\n  interval: RecurringInterval;\n  unitAmount: number; // amount in the smallest unit of the currency, e.g., cents\n  unitDecimals: number; // number of decimals for the smallest unit of the currency\n  /** only usd for now */\n  currency: Currency;\n  trialPeriodDays: number;\n  minBillingCycles: number;\n};\n\nexport type ProductPricing = {\n  name: ProductType;\n  prices: ProductPrice[];\n};\n\nexport type TokenPaymentInfo = {\n  symbol: string;\n  address: Hex;\n  decimals: number;\n  /**\n   * example: {\n      usd: '1.0',\n    },\n   */\n  conversionRate: {\n    usd: string;\n  };\n};\n\nexport type ChainPaymentInfo = {\n  chainId: Hex;\n  paymentAddress: Hex;\n  tokens: TokenPaymentInfo[];\n};\n\nexport type PricingPaymentMethod = {\n  type: PaymentType;\n  chains?: ChainPaymentInfo[];\n};\n\nexport type PricingResponse = {\n  products: ProductPricing[];\n  paymentMethods: PricingPaymentMethod[];\n};\n\nexport type GetCryptoApproveTransactionRequest = {\n  /**\n   * payment chain ID\n   */\n  chainId: Hex;\n  /**\n   * Payment token address\n   */\n  paymentTokenAddress: Hex;\n  productType: ProductType;\n  interval: RecurringInterval;\n};\n\nexport type GetCryptoApproveTransactionResponse = {\n  /**\n   * The amount to approve\n   * e.g: \"100000000\"\n   */\n  approveAmount: string;\n  /**\n   * The contract address (spender)\n   */\n  paymentAddress: Hex;\n  /**\n   * The payment token address\n   */\n  paymentTokenAddress: Hex;\n  chainId: Hex;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  minBalanceUSD: number;\n  canViewEntryModal: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n};\n\nexport type ISubscriptionService = {\n  getSubscriptions(): Promise<GetSubscriptionsResponse>;\n  cancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  unCancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  startSubscriptionWithCard(\n    request: StartSubscriptionRequest,\n  ): Promise<StartSubscriptionResponse>;\n  getBillingPortalUrl(): Promise<BillingPortalResponse>;\n  getPricing(): Promise<PricingResponse>;\n  startSubscriptionWithCrypto(\n    request: StartCryptoSubscriptionRequest,\n  ): Promise<StartCryptoSubscriptionResponse>;\n  updatePaymentMethodCard(\n    request: UpdatePaymentMethodCardRequest,\n  ): Promise<UpdatePaymentMethodCardResponse>;\n  updatePaymentMethodCrypto(\n    request: UpdatePaymentMethodCryptoRequest,\n  ): Promise<void>;\n  getSubscriptionsEligibilities(): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n};\n\nexport type UpdatePaymentMethodOpts =\n  | ({\n      paymentType: Extract<PaymentType, 'card'>;\n    } & UpdatePaymentMethodCardRequest)\n  | ({\n      paymentType: Extract<PaymentType, 'crypto'>;\n    } & UpdatePaymentMethodCryptoRequest);\n\nexport type UpdatePaymentMethodCardRequest = {\n  /**\n   * Subscription ID\n   */\n  subscriptionId: string;\n\n  /**\n   * Recurring interval\n   */\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type UpdatePaymentMethodCardResponse = {\n  redirectUrl: string;\n};\n\nexport type UpdatePaymentMethodCryptoRequest = {\n  subscriptionId: string;\n  chainId: Hex;\n  payerAddress: Hex;\n  tokenSymbol: string;\n  /**\n   * The raw transaction to pay for the subscription\n   * Can be empty if retry after topping up balance\n   */\n  rawTransaction?: Hex;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type BillingPortalResponse = {\n  url: string;\n};\n"]}
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG;IAC3B,MAAM,EAAE,QAAQ;CACR,CAAC;AAIE,QAAA,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAIE,QAAA,mBAAmB,GAAG;IACjC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKE,QAAA,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,gBAAgB;IAChB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB;IACjB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,QAAQ;IAChB,mBAAmB;IACnB,QAAQ,EAAE,UAAU;IACpB,gBAAgB;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AAKE,QAAA,4BAA4B,GAAG;IAC1C,4BAA4B,EAAE,8BAA8B;IAC5D,6BAA6B,EAAE,+BAA+B;IAC9D,sDAAsD,EACpD,wDAAwD;IAC1D,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAsLE,QAAA,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;CAC3C,CAAC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nexport const PRODUCT_TYPES = {\n  SHIELD: 'shield',\n} as const;\n\nexport type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];\n\nexport const PAYMENT_TYPES = {\n  byCard: 'card',\n  byCrypto: 'crypto',\n} as const;\n\nexport type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];\n\nexport const RECURRING_INTERVALS = {\n  month: 'month',\n  year: 'year',\n} as const;\n\nexport type RecurringInterval =\n  (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];\n\nexport const SUBSCRIPTION_STATUSES = {\n  // Initial states\n  incomplete: 'incomplete',\n  incompleteExpired: 'incomplete_expired',\n  // Active states\n  provisional: 'provisional',\n  trialing: 'trialing',\n  active: 'active',\n  // Payment issues\n  pastDue: 'past_due',\n  unpaid: 'unpaid',\n  // Cancelled states\n  canceled: 'canceled',\n  // Paused states\n  paused: 'paused',\n} as const;\n\nexport type SubscriptionStatus =\n  (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];\n\nexport const CRYPTO_PAYMENT_METHOD_ERRORS = {\n  APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',\n  APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',\n  APPROVAL_TRANSACTION_MAX_VERIFICATION_ATTEMPTS_REACHED:\n    'approval_transaction_max_verification_attempts_reached',\n  INSUFFICIENT_BALANCE: 'insufficient_balance',\n  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',\n} as const;\n\nexport type CryptoPaymentMethodError =\n  (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];\n\n/** only usd for now */\nexport type Currency = 'usd';\n\nexport type Product = {\n  name: ProductType;\n  currency: Currency;\n  unitAmount: number;\n  unitDecimals: number;\n};\n\n// state\nexport type Subscription = {\n  id: string;\n  products: Product[];\n  currentPeriodStart: string; // ISO 8601\n  currentPeriodEnd: string; // ISO 8601\n  /** is subscription scheduled for cancellation */\n  cancelAtPeriodEnd?: boolean;\n  status: SubscriptionStatus;\n  interval: RecurringInterval;\n  paymentMethod: SubscriptionPaymentMethod;\n  trialPeriodDays?: number;\n  trialStart?: string; // ISO 8601\n  trialEnd?: string; // ISO 8601\n  /** Crypto payment only: next billing cycle date (e.g after 12 months) */\n  endDate?: string; // ISO 8601\n  billingCycles?: number;\n};\n\nexport type SubscriptionCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  card: {\n    brand: string;\n    /** display brand account for dual brand card */\n    displayBrand: string;\n    last4: string;\n  };\n};\n\nexport type SubscriptionCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  crypto: {\n    payerAddress: Hex;\n    chainId: Hex;\n    tokenSymbol: string;\n    error?: CryptoPaymentMethodError;\n  };\n};\n\nexport type SubscriptionPaymentMethod =\n  | SubscriptionCardPaymentMethod\n  | SubscriptionCryptoPaymentMethod;\n\nexport type GetSubscriptionsResponse = {\n  customerId?: string;\n  subscriptions: Subscription[];\n  trialedProducts: ProductType[];\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type StartSubscriptionResponse = {\n  checkoutSessionUrl: string;\n};\n\nexport type StartCryptoSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n  chainId: Hex;\n  payerAddress: Hex;\n  /**\n   * e.g. \"USDC\"\n   */\n  tokenSymbol: string;\n  rawTransaction: Hex;\n  isSponsored?: boolean;\n  smartTransactionId?: string;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\nexport type AuthUtils = {\n  getAccessToken: () => Promise<string>;\n};\n\nexport type ProductPrice = {\n  interval: RecurringInterval;\n  unitAmount: number; // amount in the smallest unit of the currency, e.g., cents\n  unitDecimals: number; // number of decimals for the smallest unit of the currency\n  /** only usd for now */\n  currency: Currency;\n  trialPeriodDays: number;\n  minBillingCycles: number;\n};\n\nexport type ProductPricing = {\n  name: ProductType;\n  prices: ProductPrice[];\n};\n\nexport type TokenPaymentInfo = {\n  symbol: string;\n  address: Hex;\n  decimals: number;\n  /**\n   * example: {\n      usd: '1.0',\n    },\n   */\n  conversionRate: {\n    usd: string;\n  };\n};\n\nexport type ChainPaymentInfo = {\n  chainId: Hex;\n  paymentAddress: Hex;\n  tokens: TokenPaymentInfo[];\n};\n\nexport type PricingPaymentMethod = {\n  type: PaymentType;\n  chains?: ChainPaymentInfo[];\n};\n\nexport type PricingResponse = {\n  products: ProductPricing[];\n  paymentMethods: PricingPaymentMethod[];\n};\n\nexport type GetCryptoApproveTransactionRequest = {\n  /**\n   * payment chain ID\n   */\n  chainId: Hex;\n  /**\n   * Payment token address\n   */\n  paymentTokenAddress: Hex;\n  productType: ProductType;\n  interval: RecurringInterval;\n};\n\nexport type GetCryptoApproveTransactionResponse = {\n  /**\n   * The amount to approve\n   * e.g: \"100000000\"\n   */\n  approveAmount: string;\n  /**\n   * The contract address (spender)\n   */\n  paymentAddress: Hex;\n  /**\n   * The payment token address\n   */\n  paymentTokenAddress: Hex;\n  chainId: Hex;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  minBalanceUSD: number;\n  canViewEntryModal: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n};\n\n/**\n * Request object for submitting sponsorship intents.\n */\nexport type SubmitSponsorshipIntentsRequest = {\n  chainId: Hex;\n  address: Hex;\n  products: ProductType[];\n  paymentTokenSymbol: string;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type SubmitSponsorshipIntentsMethodParams = Pick<\n  SubmitSponsorshipIntentsRequest,\n  'chainId' | 'address' | 'products'\n>;\n\nexport type ISubscriptionService = {\n  getSubscriptions(): Promise<GetSubscriptionsResponse>;\n  cancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  unCancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  startSubscriptionWithCard(\n    request: StartSubscriptionRequest,\n  ): Promise<StartSubscriptionResponse>;\n  getBillingPortalUrl(): Promise<BillingPortalResponse>;\n  getPricing(): Promise<PricingResponse>;\n  startSubscriptionWithCrypto(\n    request: StartCryptoSubscriptionRequest,\n  ): Promise<StartCryptoSubscriptionResponse>;\n  updatePaymentMethodCard(\n    request: UpdatePaymentMethodCardRequest,\n  ): Promise<UpdatePaymentMethodCardResponse>;\n  updatePaymentMethodCrypto(\n    request: UpdatePaymentMethodCryptoRequest,\n  ): Promise<void>;\n  getSubscriptionsEligibilities(): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\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   */\n  submitSponsorshipIntents(\n    request: SubmitSponsorshipIntentsRequest,\n  ): Promise<void>;\n};\n\nexport type UpdatePaymentMethodOpts =\n  | ({\n      paymentType: Extract<PaymentType, 'card'>;\n    } & UpdatePaymentMethodCardRequest)\n  | ({\n      paymentType: Extract<PaymentType, 'crypto'>;\n    } & UpdatePaymentMethodCryptoRequest);\n\nexport type UpdatePaymentMethodCardRequest = {\n  /**\n   * Subscription ID\n   */\n  subscriptionId: string;\n\n  /**\n   * Recurring interval\n   */\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type UpdatePaymentMethodCardResponse = {\n  redirectUrl: string;\n};\n\nexport type UpdatePaymentMethodCryptoRequest = {\n  subscriptionId: string;\n  chainId: Hex;\n  payerAddress: Hex;\n  tokenSymbol: string;\n  /**\n   * The raw transaction to pay for the subscription\n   * Can be empty if retry after topping up balance\n   */\n  rawTransaction?: Hex;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type BillingPortalResponse = {\n  url: string;\n};\n\n/**\n * The cached result of last selected payment methods for the user.\n * These details are being cached to be used internally to track the last selected payment method for the user. (e.g. for crypto subscriptions)\n */\nexport type CachedLastSelectedPaymentMethod = {\n  type: PaymentType;\n  paymentTokenAddress?: Hex;\n  paymentTokenSymbol?: string;\n  plan: RecurringInterval;\n};\n"]}

package/dist/types.d.cts

@@ -103,6 +103,8 @@ export type StartCryptoSubscriptionRequest = {
      */
     tokenSymbol: string;
     rawTransaction: Hex;
+    isSponsored?: boolean;
+    smartTransactionId?: string;
 };
 export type StartCryptoSubscriptionResponse = {
     subscriptionId: string;
@@ -191,6 +193,18 @@ export type SubscriptionUserEventType = (typeof SubscriptionUserEvent)[keyof typ
 export type SubmitUserEventRequest = {
     event: SubscriptionUserEventType;
 };
+/**
+ * Request object for submitting sponsorship intents.
+ */
+export type SubmitSponsorshipIntentsRequest = {
+    chainId: Hex;
+    address: Hex;
+    products: ProductType[];
+    paymentTokenSymbol: string;
+    recurringInterval: RecurringInterval;
+    billingCycles: number;
+};
+export type SubmitSponsorshipIntentsMethodParams = Pick<SubmitSponsorshipIntentsRequest, 'chainId' | 'address' | 'products'>;
 export type ISubscriptionService = {
     getSubscriptions(): Promise<GetSubscriptionsResponse>;
     cancelSubscription(request: {
@@ -207,6 +221,21 @@ export type ISubscriptionService = {
     updatePaymentMethodCrypto(request: UpdatePaymentMethodCryptoRequest): Promise<void>;
     getSubscriptionsEligibilities(): Promise<SubscriptionEligibility[]>;
     submitUserEvent(request: SubmitUserEventRequest): Promise<void>;
+    /**
+     * 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,
+     * }
+     */
+    submitSponsorshipIntents(request: SubmitSponsorshipIntentsRequest): Promise<void>;
 };
 export type UpdatePaymentMethodOpts = ({
     paymentType: Extract<PaymentType, 'card'>;
@@ -243,4 +272,14 @@ export type UpdatePaymentMethodCryptoRequest = {
 export type BillingPortalResponse = {
     url: string;
 };
+/**
+ * The cached result of last selected payment methods for the user.
+ * These details are being cached to be used internally to track the last selected payment method for the user. (e.g. for crypto subscriptions)
+ */
+export type CachedLastSelectedPaymentMethod = {
+    type: PaymentType;
+    paymentTokenAddress?: Hex;
+    paymentTokenSymbol?: string;
+    plan: RecurringInterval;
+};
 //# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,eAAO,MAAM,aAAa;;CAEhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,aAAa;;;CAGhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB;;;;;;;;;;CAexB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,4BAA4B;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,yBAAyB,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,gDAAgD;QAChD,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,WAAW,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,EAAE;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,EAAE,GAAG,CAAC;IACpB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;CAExB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,yBAAyB,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD,kBAAkB,CAAC,OAAO,EAAE;QAC1B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,oBAAoB,CAAC,OAAO,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,yBAAyB,CACvB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,2BAA2B,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,uBAAuB,CACrB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,yBAAyB,CACvB,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,6BAA6B,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACpE,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3C,GAAG,8BAA8B,CAAC,GACnC,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC7C,GAAG,gCAAgC,CAAC,CAAC;AAE1C,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,eAAO,MAAM,aAAa;;CAEhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,aAAa;;;CAGhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB;;;;;;;;;;CAexB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,4BAA4B;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,yBAAyB,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,gDAAgD;QAChD,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,WAAW,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,GAAG,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,EAAE;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,EAAE,GAAG,CAAC;IACpB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;CAExB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,yBAAyB,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,IAAI,CACrD,+BAA+B,EAC/B,SAAS,GAAG,SAAS,GAAG,UAAU,CACnC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD,kBAAkB,CAAC,OAAO,EAAE;QAC1B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,oBAAoB,CAAC,OAAO,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,yBAAyB,CACvB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,2BAA2B,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,uBAAuB,CACrB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,yBAAyB,CACvB,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,6BAA6B,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACpE,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3C,GAAG,8BAA8B,CAAC,GACnC,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC7C,GAAG,gCAAgC,CAAC,CAAC;AAE1C,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,WAAW,CAAC;IAClB,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC"}

package/dist/types.d.mts

@@ -103,6 +103,8 @@ export type StartCryptoSubscriptionRequest = {
      */
     tokenSymbol: string;
     rawTransaction: Hex;
+    isSponsored?: boolean;
+    smartTransactionId?: string;
 };
 export type StartCryptoSubscriptionResponse = {
     subscriptionId: string;
@@ -191,6 +193,18 @@ export type SubscriptionUserEventType = (typeof SubscriptionUserEvent)[keyof typ
 export type SubmitUserEventRequest = {
     event: SubscriptionUserEventType;
 };
+/**
+ * Request object for submitting sponsorship intents.
+ */
+export type SubmitSponsorshipIntentsRequest = {
+    chainId: Hex;
+    address: Hex;
+    products: ProductType[];
+    paymentTokenSymbol: string;
+    recurringInterval: RecurringInterval;
+    billingCycles: number;
+};
+export type SubmitSponsorshipIntentsMethodParams = Pick<SubmitSponsorshipIntentsRequest, 'chainId' | 'address' | 'products'>;
 export type ISubscriptionService = {
     getSubscriptions(): Promise<GetSubscriptionsResponse>;
     cancelSubscription(request: {
@@ -207,6 +221,21 @@ export type ISubscriptionService = {
     updatePaymentMethodCrypto(request: UpdatePaymentMethodCryptoRequest): Promise<void>;
     getSubscriptionsEligibilities(): Promise<SubscriptionEligibility[]>;
     submitUserEvent(request: SubmitUserEventRequest): Promise<void>;
+    /**
+     * 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,
+     * }
+     */
+    submitSponsorshipIntents(request: SubmitSponsorshipIntentsRequest): Promise<void>;
 };
 export type UpdatePaymentMethodOpts = ({
     paymentType: Extract<PaymentType, 'card'>;
@@ -243,4 +272,14 @@ export type UpdatePaymentMethodCryptoRequest = {
 export type BillingPortalResponse = {
     url: string;
 };
+/**
+ * The cached result of last selected payment methods for the user.
+ * These details are being cached to be used internally to track the last selected payment method for the user. (e.g. for crypto subscriptions)
+ */
+export type CachedLastSelectedPaymentMethod = {
+    type: PaymentType;
+    paymentTokenAddress?: Hex;
+    paymentTokenSymbol?: string;
+    plan: RecurringInterval;
+};
 //# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,eAAO,MAAM,aAAa;;CAEhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,aAAa;;;CAGhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB;;;;;;;;;;CAexB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,4BAA4B;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,yBAAyB,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,gDAAgD;QAChD,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,WAAW,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,EAAE;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,EAAE,GAAG,CAAC;IACpB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;CAExB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,yBAAyB,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD,kBAAkB,CAAC,OAAO,EAAE;QAC1B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,oBAAoB,CAAC,OAAO,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,yBAAyB,CACvB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,2BAA2B,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,uBAAuB,CACrB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,yBAAyB,CACvB,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,6BAA6B,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACpE,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3C,GAAG,8BAA8B,CAAC,GACnC,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC7C,GAAG,gCAAgC,CAAC,CAAC;AAE1C,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,eAAO,MAAM,aAAa;;CAEhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,aAAa;;;CAGhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB;;;;;;;;;;CAexB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,4BAA4B;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,yBAAyB,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,gDAAgD;QAChD,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,WAAW,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,GAAG,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,EAAE;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,EAAE,GAAG,CAAC;IACpB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;CAExB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,yBAAyB,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,IAAI,CACrD,+BAA+B,EAC/B,SAAS,GAAG,SAAS,GAAG,UAAU,CACnC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD,kBAAkB,CAAC,OAAO,EAAE;QAC1B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,oBAAoB,CAAC,OAAO,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B,yBAAyB,CACvB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,2BAA2B,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,uBAAuB,CACrB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,yBAAyB,CACvB,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,6BAA6B,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACpE,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3C,GAAG,8BAA8B,CAAC,GACnC,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC7C,GAAG,gCAAgC,CAAC,CAAC;AAE1C,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,WAAW,CAAC;IAClB,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC"}

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,QAAQ;CACR,CAAC;AAIX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,gBAAgB;IAChB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB;IACjB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,QAAQ;IAChB,mBAAmB;IACnB,QAAQ,EAAE,UAAU;IACpB,gBAAgB;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AAKX,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,4BAA4B,EAAE,8BAA8B;IAC5D,6BAA6B,EAAE,+BAA+B;IAC9D,sDAAsD,EACpD,wDAAwD;IAC1D,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAoLX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;CAC3C,CAAC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nexport const PRODUCT_TYPES = {\n  SHIELD: 'shield',\n} as const;\n\nexport type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];\n\nexport const PAYMENT_TYPES = {\n  byCard: 'card',\n  byCrypto: 'crypto',\n} as const;\n\nexport type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];\n\nexport const RECURRING_INTERVALS = {\n  month: 'month',\n  year: 'year',\n} as const;\n\nexport type RecurringInterval =\n  (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];\n\nexport const SUBSCRIPTION_STATUSES = {\n  // Initial states\n  incomplete: 'incomplete',\n  incompleteExpired: 'incomplete_expired',\n  // Active states\n  provisional: 'provisional',\n  trialing: 'trialing',\n  active: 'active',\n  // Payment issues\n  pastDue: 'past_due',\n  unpaid: 'unpaid',\n  // Cancelled states\n  canceled: 'canceled',\n  // Paused states\n  paused: 'paused',\n} as const;\n\nexport type SubscriptionStatus =\n  (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];\n\nexport const CRYPTO_PAYMENT_METHOD_ERRORS = {\n  APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',\n  APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',\n  APPROVAL_TRANSACTION_MAX_VERIFICATION_ATTEMPTS_REACHED:\n    'approval_transaction_max_verification_attempts_reached',\n  INSUFFICIENT_BALANCE: 'insufficient_balance',\n  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',\n} as const;\n\nexport type CryptoPaymentMethodError =\n  (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];\n\n/** only usd for now */\nexport type Currency = 'usd';\n\nexport type Product = {\n  name: ProductType;\n  currency: Currency;\n  unitAmount: number;\n  unitDecimals: number;\n};\n\n// state\nexport type Subscription = {\n  id: string;\n  products: Product[];\n  currentPeriodStart: string; // ISO 8601\n  currentPeriodEnd: string; // ISO 8601\n  /** is subscription scheduled for cancellation */\n  cancelAtPeriodEnd?: boolean;\n  status: SubscriptionStatus;\n  interval: RecurringInterval;\n  paymentMethod: SubscriptionPaymentMethod;\n  trialPeriodDays?: number;\n  trialStart?: string; // ISO 8601\n  trialEnd?: string; // ISO 8601\n  /** Crypto payment only: next billing cycle date (e.g after 12 months) */\n  endDate?: string; // ISO 8601\n  billingCycles?: number;\n};\n\nexport type SubscriptionCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  card: {\n    brand: string;\n    /** display brand account for dual brand card */\n    displayBrand: string;\n    last4: string;\n  };\n};\n\nexport type SubscriptionCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  crypto: {\n    payerAddress: Hex;\n    chainId: Hex;\n    tokenSymbol: string;\n    error?: CryptoPaymentMethodError;\n  };\n};\n\nexport type SubscriptionPaymentMethod =\n  | SubscriptionCardPaymentMethod\n  | SubscriptionCryptoPaymentMethod;\n\nexport type GetSubscriptionsResponse = {\n  customerId?: string;\n  subscriptions: Subscription[];\n  trialedProducts: ProductType[];\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type StartSubscriptionResponse = {\n  checkoutSessionUrl: string;\n};\n\nexport type StartCryptoSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n  chainId: Hex;\n  payerAddress: Hex;\n  /**\n   * e.g. \"USDC\"\n   */\n  tokenSymbol: string;\n  rawTransaction: Hex;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\nexport type AuthUtils = {\n  getAccessToken: () => Promise<string>;\n};\n\nexport type ProductPrice = {\n  interval: RecurringInterval;\n  unitAmount: number; // amount in the smallest unit of the currency, e.g., cents\n  unitDecimals: number; // number of decimals for the smallest unit of the currency\n  /** only usd for now */\n  currency: Currency;\n  trialPeriodDays: number;\n  minBillingCycles: number;\n};\n\nexport type ProductPricing = {\n  name: ProductType;\n  prices: ProductPrice[];\n};\n\nexport type TokenPaymentInfo = {\n  symbol: string;\n  address: Hex;\n  decimals: number;\n  /**\n   * example: {\n      usd: '1.0',\n    },\n   */\n  conversionRate: {\n    usd: string;\n  };\n};\n\nexport type ChainPaymentInfo = {\n  chainId: Hex;\n  paymentAddress: Hex;\n  tokens: TokenPaymentInfo[];\n};\n\nexport type PricingPaymentMethod = {\n  type: PaymentType;\n  chains?: ChainPaymentInfo[];\n};\n\nexport type PricingResponse = {\n  products: ProductPricing[];\n  paymentMethods: PricingPaymentMethod[];\n};\n\nexport type GetCryptoApproveTransactionRequest = {\n  /**\n   * payment chain ID\n   */\n  chainId: Hex;\n  /**\n   * Payment token address\n   */\n  paymentTokenAddress: Hex;\n  productType: ProductType;\n  interval: RecurringInterval;\n};\n\nexport type GetCryptoApproveTransactionResponse = {\n  /**\n   * The amount to approve\n   * e.g: \"100000000\"\n   */\n  approveAmount: string;\n  /**\n   * The contract address (spender)\n   */\n  paymentAddress: Hex;\n  /**\n   * The payment token address\n   */\n  paymentTokenAddress: Hex;\n  chainId: Hex;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  minBalanceUSD: number;\n  canViewEntryModal: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n};\n\nexport type ISubscriptionService = {\n  getSubscriptions(): Promise<GetSubscriptionsResponse>;\n  cancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  unCancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  startSubscriptionWithCard(\n    request: StartSubscriptionRequest,\n  ): Promise<StartSubscriptionResponse>;\n  getBillingPortalUrl(): Promise<BillingPortalResponse>;\n  getPricing(): Promise<PricingResponse>;\n  startSubscriptionWithCrypto(\n    request: StartCryptoSubscriptionRequest,\n  ): Promise<StartCryptoSubscriptionResponse>;\n  updatePaymentMethodCard(\n    request: UpdatePaymentMethodCardRequest,\n  ): Promise<UpdatePaymentMethodCardResponse>;\n  updatePaymentMethodCrypto(\n    request: UpdatePaymentMethodCryptoRequest,\n  ): Promise<void>;\n  getSubscriptionsEligibilities(): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n};\n\nexport type UpdatePaymentMethodOpts =\n  | ({\n      paymentType: Extract<PaymentType, 'card'>;\n    } & UpdatePaymentMethodCardRequest)\n  | ({\n      paymentType: Extract<PaymentType, 'crypto'>;\n    } & UpdatePaymentMethodCryptoRequest);\n\nexport type UpdatePaymentMethodCardRequest = {\n  /**\n   * Subscription ID\n   */\n  subscriptionId: string;\n\n  /**\n   * Recurring interval\n   */\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type UpdatePaymentMethodCardResponse = {\n  redirectUrl: string;\n};\n\nexport type UpdatePaymentMethodCryptoRequest = {\n  subscriptionId: string;\n  chainId: Hex;\n  payerAddress: Hex;\n  tokenSymbol: string;\n  /**\n   * The raw transaction to pay for the subscription\n   * Can be empty if retry after topping up balance\n   */\n  rawTransaction?: Hex;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type BillingPortalResponse = {\n  url: string;\n};\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,QAAQ;CACR,CAAC;AAIX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,gBAAgB;IAChB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB;IACjB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,QAAQ;IAChB,mBAAmB;IACnB,QAAQ,EAAE,UAAU;IACpB,gBAAgB;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AAKX,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,4BAA4B,EAAE,8BAA8B;IAC5D,6BAA6B,EAAE,+BAA+B;IAC9D,sDAAsD,EACpD,wDAAwD;IAC1D,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAsLX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;CAC3C,CAAC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nexport const PRODUCT_TYPES = {\n  SHIELD: 'shield',\n} as const;\n\nexport type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];\n\nexport const PAYMENT_TYPES = {\n  byCard: 'card',\n  byCrypto: 'crypto',\n} as const;\n\nexport type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];\n\nexport const RECURRING_INTERVALS = {\n  month: 'month',\n  year: 'year',\n} as const;\n\nexport type RecurringInterval =\n  (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];\n\nexport const SUBSCRIPTION_STATUSES = {\n  // Initial states\n  incomplete: 'incomplete',\n  incompleteExpired: 'incomplete_expired',\n  // Active states\n  provisional: 'provisional',\n  trialing: 'trialing',\n  active: 'active',\n  // Payment issues\n  pastDue: 'past_due',\n  unpaid: 'unpaid',\n  // Cancelled states\n  canceled: 'canceled',\n  // Paused states\n  paused: 'paused',\n} as const;\n\nexport type SubscriptionStatus =\n  (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];\n\nexport const CRYPTO_PAYMENT_METHOD_ERRORS = {\n  APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',\n  APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',\n  APPROVAL_TRANSACTION_MAX_VERIFICATION_ATTEMPTS_REACHED:\n    'approval_transaction_max_verification_attempts_reached',\n  INSUFFICIENT_BALANCE: 'insufficient_balance',\n  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',\n} as const;\n\nexport type CryptoPaymentMethodError =\n  (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];\n\n/** only usd for now */\nexport type Currency = 'usd';\n\nexport type Product = {\n  name: ProductType;\n  currency: Currency;\n  unitAmount: number;\n  unitDecimals: number;\n};\n\n// state\nexport type Subscription = {\n  id: string;\n  products: Product[];\n  currentPeriodStart: string; // ISO 8601\n  currentPeriodEnd: string; // ISO 8601\n  /** is subscription scheduled for cancellation */\n  cancelAtPeriodEnd?: boolean;\n  status: SubscriptionStatus;\n  interval: RecurringInterval;\n  paymentMethod: SubscriptionPaymentMethod;\n  trialPeriodDays?: number;\n  trialStart?: string; // ISO 8601\n  trialEnd?: string; // ISO 8601\n  /** Crypto payment only: next billing cycle date (e.g after 12 months) */\n  endDate?: string; // ISO 8601\n  billingCycles?: number;\n};\n\nexport type SubscriptionCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  card: {\n    brand: string;\n    /** display brand account for dual brand card */\n    displayBrand: string;\n    last4: string;\n  };\n};\n\nexport type SubscriptionCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  crypto: {\n    payerAddress: Hex;\n    chainId: Hex;\n    tokenSymbol: string;\n    error?: CryptoPaymentMethodError;\n  };\n};\n\nexport type SubscriptionPaymentMethod =\n  | SubscriptionCardPaymentMethod\n  | SubscriptionCryptoPaymentMethod;\n\nexport type GetSubscriptionsResponse = {\n  customerId?: string;\n  subscriptions: Subscription[];\n  trialedProducts: ProductType[];\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type StartSubscriptionResponse = {\n  checkoutSessionUrl: string;\n};\n\nexport type StartCryptoSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n  chainId: Hex;\n  payerAddress: Hex;\n  /**\n   * e.g. \"USDC\"\n   */\n  tokenSymbol: string;\n  rawTransaction: Hex;\n  isSponsored?: boolean;\n  smartTransactionId?: string;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\nexport type AuthUtils = {\n  getAccessToken: () => Promise<string>;\n};\n\nexport type ProductPrice = {\n  interval: RecurringInterval;\n  unitAmount: number; // amount in the smallest unit of the currency, e.g., cents\n  unitDecimals: number; // number of decimals for the smallest unit of the currency\n  /** only usd for now */\n  currency: Currency;\n  trialPeriodDays: number;\n  minBillingCycles: number;\n};\n\nexport type ProductPricing = {\n  name: ProductType;\n  prices: ProductPrice[];\n};\n\nexport type TokenPaymentInfo = {\n  symbol: string;\n  address: Hex;\n  decimals: number;\n  /**\n   * example: {\n      usd: '1.0',\n    },\n   */\n  conversionRate: {\n    usd: string;\n  };\n};\n\nexport type ChainPaymentInfo = {\n  chainId: Hex;\n  paymentAddress: Hex;\n  tokens: TokenPaymentInfo[];\n};\n\nexport type PricingPaymentMethod = {\n  type: PaymentType;\n  chains?: ChainPaymentInfo[];\n};\n\nexport type PricingResponse = {\n  products: ProductPricing[];\n  paymentMethods: PricingPaymentMethod[];\n};\n\nexport type GetCryptoApproveTransactionRequest = {\n  /**\n   * payment chain ID\n   */\n  chainId: Hex;\n  /**\n   * Payment token address\n   */\n  paymentTokenAddress: Hex;\n  productType: ProductType;\n  interval: RecurringInterval;\n};\n\nexport type GetCryptoApproveTransactionResponse = {\n  /**\n   * The amount to approve\n   * e.g: \"100000000\"\n   */\n  approveAmount: string;\n  /**\n   * The contract address (spender)\n   */\n  paymentAddress: Hex;\n  /**\n   * The payment token address\n   */\n  paymentTokenAddress: Hex;\n  chainId: Hex;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  minBalanceUSD: number;\n  canViewEntryModal: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n};\n\n/**\n * Request object for submitting sponsorship intents.\n */\nexport type SubmitSponsorshipIntentsRequest = {\n  chainId: Hex;\n  address: Hex;\n  products: ProductType[];\n  paymentTokenSymbol: string;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type SubmitSponsorshipIntentsMethodParams = Pick<\n  SubmitSponsorshipIntentsRequest,\n  'chainId' | 'address' | 'products'\n>;\n\nexport type ISubscriptionService = {\n  getSubscriptions(): Promise<GetSubscriptionsResponse>;\n  cancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  unCancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  startSubscriptionWithCard(\n    request: StartSubscriptionRequest,\n  ): Promise<StartSubscriptionResponse>;\n  getBillingPortalUrl(): Promise<BillingPortalResponse>;\n  getPricing(): Promise<PricingResponse>;\n  startSubscriptionWithCrypto(\n    request: StartCryptoSubscriptionRequest,\n  ): Promise<StartCryptoSubscriptionResponse>;\n  updatePaymentMethodCard(\n    request: UpdatePaymentMethodCardRequest,\n  ): Promise<UpdatePaymentMethodCardResponse>;\n  updatePaymentMethodCrypto(\n    request: UpdatePaymentMethodCryptoRequest,\n  ): Promise<void>;\n  getSubscriptionsEligibilities(): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\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   */\n  submitSponsorshipIntents(\n    request: SubmitSponsorshipIntentsRequest,\n  ): Promise<void>;\n};\n\nexport type UpdatePaymentMethodOpts =\n  | ({\n      paymentType: Extract<PaymentType, 'card'>;\n    } & UpdatePaymentMethodCardRequest)\n  | ({\n      paymentType: Extract<PaymentType, 'crypto'>;\n    } & UpdatePaymentMethodCryptoRequest);\n\nexport type UpdatePaymentMethodCardRequest = {\n  /**\n   * Subscription ID\n   */\n  subscriptionId: string;\n\n  /**\n   * Recurring interval\n   */\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n};\n\nexport type UpdatePaymentMethodCardResponse = {\n  redirectUrl: string;\n};\n\nexport type UpdatePaymentMethodCryptoRequest = {\n  subscriptionId: string;\n  chainId: Hex;\n  payerAddress: Hex;\n  tokenSymbol: string;\n  /**\n   * The raw transaction to pay for the subscription\n   * Can be empty if retry after topping up balance\n   */\n  rawTransaction?: Hex;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type BillingPortalResponse = {\n  url: string;\n};\n\n/**\n * The cached result of last selected payment methods for the user.\n * These details are being cached to be used internally to track the last selected payment method for the user. (e.g. for crypto subscriptions)\n */\nexport type CachedLastSelectedPaymentMethod = {\n  type: PaymentType;\n  paymentTokenAddress?: Hex;\n  paymentTokenSymbol?: string;\n  plan: RecurringInterval;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/subscription-controller",
-  "version": "2.1.0-preview-9fa15fd0",
+  "version": "3.0.0-preview-55f130d1",
   "description": "Handle user subscription",
   "keywords": [
     "MetaMask",
@@ -47,14 +47,15 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.4.2",
+    "@metamask/base-controller": "^9.0.0",
     "@metamask/controller-utils": "^11.14.1",
-    "@metamask/polling-controller": "^14.0.2",
+    "@metamask/messenger": "^0.3.0",
+    "@metamask/polling-controller": "^15.0.0",
     "@metamask/utils": "^11.8.1"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/profile-sync-controller": "^25.1.2",
+    "@metamask/profile-sync-controller": "^26.0.0",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
@@ -65,7 +66,7 @@
     "typescript": "~5.2.2"
   },
   "peerDependencies": {
-    "@metamask/profile-sync-controller": "^25.0.0"
+    "@metamask/profile-sync-controller": "^26.0.0"
   },
   "engines": {
     "node": "^18.18 || >=20"