@metamask-previews/subscription-controller 5.4.0-preview-766f7065 → 5.4.1-preview-cd0d0950

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAuBA,OAAO,EACL,sBAAsB,EACtB,qCAAqC,EACtC,qCAAiC;AA6ClC,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACX,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  SubscriptionControllerSubmitSponsorshipIntentsAction,\n  SubscriptionControllerLinkRewardsAction,\n  SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction,\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,\n  SubmitSponsorshipIntentsMethodParams,\n  Cohort,\n  CohortName,\n  BalanceCategory,\n  AssignCohortRequest,\n  GetSubscriptionsEligibilitiesRequest,\n  ModalType,\n} from './types';\nexport {\n  CRYPTO_PAYMENT_METHOD_ERRORS,\n  SUBSCRIPTION_STATUSES,\n  PRODUCT_TYPES,\n  RECURRING_INTERVALS,\n  PAYMENT_TYPES,\n  SubscriptionUserEvent,\n  COHORT_NAMES,\n  BALANCE_CATEGORIES,\n  MODAL_TYPE,\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":"AAuBA,OAAO,EACL,sBAAsB,EACtB,qCAAqC,EACtC,qCAAiC;AA+ClC,OAAO,EACL,YAAY,EACZ,4BAA4B,EAC5B,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACX,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  SubscriptionControllerSubmitSponsorshipIntentsAction,\n  SubscriptionControllerLinkRewardsAction,\n  SubscriptionControllerSubmitShieldSubscriptionCryptoApprovalAction,\n  AllowedActions,\n  AllowedEvents,\n} from './SubscriptionController';\nexport {\n  SubscriptionController,\n  getDefaultSubscriptionControllerState,\n} from './SubscriptionController';\nexport type {\n  Subscription,\n  AuthUtils,\n  CancelSubscriptionRequest,\n  CancelType,\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,\n  SubmitSponsorshipIntentsMethodParams,\n  Cohort,\n  CohortName,\n  BalanceCategory,\n  AssignCohortRequest,\n  GetSubscriptionsEligibilitiesRequest,\n  ModalType,\n} from './types';\nexport {\n  CANCEL_TYPES,\n  CRYPTO_PAYMENT_METHOD_ERRORS,\n  SUBSCRIPTION_STATUSES,\n  PRODUCT_TYPES,\n  RECURRING_INTERVALS,\n  PAYMENT_TYPES,\n  SubscriptionUserEvent,\n  COHORT_NAMES,\n  BALANCE_CATEGORIES,\n  MODAL_TYPE,\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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionUserEvent = exports.BALANCE_CATEGORIES = exports.COHORT_NAMES = exports.MODAL_TYPE = exports.CRYPTO_PAYMENT_METHOD_ERRORS = exports.SUBSCRIPTION_STATUSES = exports.RECURRING_INTERVALS = exports.PAYMENT_TYPES = exports.PRODUCT_TYPES = void 0;
+exports.SubscriptionUserEvent = exports.BALANCE_CATEGORIES = exports.COHORT_NAMES = exports.MODAL_TYPE = exports.CRYPTO_PAYMENT_METHOD_ERRORS = exports.CANCEL_TYPES = exports.SUBSCRIPTION_STATUSES = exports.RECURRING_INTERVALS = exports.PAYMENT_TYPES = exports.PRODUCT_TYPES = void 0;
 exports.PRODUCT_TYPES = {
     SHIELD: 'shield',
 };
@@ -28,6 +28,12 @@ exports.SUBSCRIPTION_STATUSES = {
     // Paused states
     paused: 'paused',
 };
+exports.CANCEL_TYPES = {
+    ALLOWED_IMMEDIATE: 'allowed_immediate',
+    ALLOWED_AT_PERIOD_END: 'allowed_at_period_end',
+    NOT_ALLOWED: 'not_allowed',
+    NOT_ALLOWED_PENDING_VERIFICATION: 'not_allowed_pending_verification',
+};
 exports.CRYPTO_PAYMENT_METHOD_ERRORS = {
     APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',
     APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',

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;AAKE,QAAA,UAAU,GAAG;IACxB,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACE,CAAC;AAmOE,QAAA,YAAY,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAIE,QAAA,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,SAAS;IACxB,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,iBAAiB,EAAE,aAAa;IAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAsBE,QAAA,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;IACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC","sourcesContent":["import type { CaipAccountId, 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\nexport const MODAL_TYPE = {\n  A: 'A',\n  B: 'B',\n} as const;\n\nexport type ModalType = (typeof MODAL_TYPE)[keyof typeof MODAL_TYPE];\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  /** The date the subscription was canceled. */\n  canceledAt?: string; // ISO 8601\n  /** The date the subscription was marked as inactive (paused/past_due/canceled). */\n  inactiveAt?: string; // ISO 8601\n  /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */\n  isEligibleForSupport: boolean;\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  /** The last subscription that user has subscribed to if any. */\n  lastSubscription?: Subscription;\n  /** The reward account ID if user has linked rewards to the subscription. */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  useTestClock?: boolean;\n\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\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  useTestClock?: boolean;\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\n/**\n * General response type for the subscription API requests\n * which doesn't require any specific response data.\n */\nexport type SubscriptionApiGeneralResponse = {\n  /**\n   * Whether the request was successful.\n   */\n  success: boolean;\n  /**\n   * The message of the response.\n   */\n  message?: string;\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  /** min billing cycles for approval */\n  minBillingCycles: number;\n  /** min billing cycles for account balance check */\n  minBillingCyclesForBalance: 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   * Whether the chain supports sponsorship for the trialed subscription approval transaction.\n   * This is used to determine if the user can be sponsored for the gas fees for the trialed subscription approval transaction.\n   */\n  isSponsorshipSupported?: boolean;\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 const COHORT_NAMES = {\n  POST_TX: 'post_tx',\n  WALLET_HOME: 'wallet_home',\n} as const;\n\nexport type CohortName = (typeof COHORT_NAMES)[keyof typeof COHORT_NAMES];\n\nexport const BALANCE_CATEGORIES = {\n  RANGE_0_99: '0-99',\n  RANGE_100_999: '100-999',\n  RANGE_1K_9_9K: '1k-9.9k',\n  RANGE_10K_99_9K: '10k-99.9k',\n  RANGE_100K_999_9K: '100k-999.9k',\n  RANGE_1M_PLUS: '1M+',\n} as const;\n\nexport type BalanceCategory =\n  (typeof BALANCE_CATEGORIES)[keyof typeof BALANCE_CATEGORIES];\n\nexport type Cohort = {\n  cohort: string;\n  eligibilityRate: number; // 0-1 probability of being assigned to this cohort\n  priority: number; // lower number = higher priority\n  eligible: boolean;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  canViewEntryModal: boolean;\n  modalType?: ModalType;\n  cohorts: Cohort[];\n  assignedCohort: string | null;\n  hasAssignedCohortExpired: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n  ShieldCohortAssigned: 'shield_cohort_assigned',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n  cohort?: string;\n};\n\nexport type AssignCohortRequest = {\n  cohort: string;\n};\n\nexport type GetSubscriptionsEligibilitiesRequest = {\n  balanceCategory?: BalanceCategory;\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(\n    request?: GetSubscriptionsEligibilitiesRequest,\n  ): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n  assignUserToCohort(request: AssignCohortRequest): Promise<void>;\n\n  /**\n   * Link rewards to a subscription.\n   */\n  linkRewards(\n    request: LinkRewardsRequest,\n  ): Promise<SubscriptionApiGeneralResponse>;\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  useTestClock?: boolean;\n};\n\n/**\n * Request object for linking rewards to a subscription.\n */\nexport type LinkRewardsRequest = {\n  /**\n   * The ID of the reward subscription to be linked to the subscription.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId: CaipAccountId;\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,YAAY,GAAG;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,WAAW,EAAE,aAAa;IAC1B,gCAAgC,EAAE,kCAAkC;CAC5D,CAAC;AAIE,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;AAKE,QAAA,UAAU,GAAG;IACxB,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACE,CAAC;AA4OE,QAAA,YAAY,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAIE,QAAA,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,SAAS;IACxB,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,iBAAiB,EAAE,aAAa;IAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAsBE,QAAA,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;IACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC","sourcesContent":["import type { CaipAccountId, 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 CANCEL_TYPES = {\n  ALLOWED_IMMEDIATE: 'allowed_immediate',\n  ALLOWED_AT_PERIOD_END: 'allowed_at_period_end',\n  NOT_ALLOWED: 'not_allowed',\n  NOT_ALLOWED_PENDING_VERIFICATION: 'not_allowed_pending_verification',\n} as const;\n\nexport type CancelType = (typeof CANCEL_TYPES)[keyof typeof CANCEL_TYPES];\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\nexport const MODAL_TYPE = {\n  A: 'A',\n  B: 'B',\n} as const;\n\nexport type ModalType = (typeof MODAL_TYPE)[keyof typeof MODAL_TYPE];\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  /** The date the subscription was canceled. */\n  canceledAt?: string; // ISO 8601\n  /** The cancellation type indicating what cancellation options are available for this subscription. */\n  cancelType: CancelType;\n  /** The date the subscription was marked as inactive (paused/past_due/canceled). */\n  inactiveAt?: string; // ISO 8601\n  /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */\n  isEligibleForSupport: boolean;\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  /** The last subscription that user has subscribed to if any. */\n  lastSubscription?: Subscription;\n  /** The reward account ID if user has linked rewards to the subscription. */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  cancelUrl?: string;\n  useTestClock?: boolean;\n\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\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  useTestClock?: boolean;\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\n/**\n * General response type for the subscription API requests\n * which doesn't require any specific response data.\n */\nexport type SubscriptionApiGeneralResponse = {\n  /**\n   * Whether the request was successful.\n   */\n  success: boolean;\n  /**\n   * The message of the response.\n   */\n  message?: string;\n};\n\nexport type CancelSubscriptionRequest = {\n  subscriptionId: string;\n  /** Whether to cancel at the end of the current period */\n  cancelAtPeriodEnd?: boolean;\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  /** min billing cycles for approval */\n  minBillingCycles: number;\n  /** min billing cycles for account balance check */\n  minBillingCyclesForBalance: 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   * Whether the chain supports sponsorship for the trialed subscription approval transaction.\n   * This is used to determine if the user can be sponsored for the gas fees for the trialed subscription approval transaction.\n   */\n  isSponsorshipSupported?: boolean;\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 const COHORT_NAMES = {\n  POST_TX: 'post_tx',\n  WALLET_HOME: 'wallet_home',\n} as const;\n\nexport type CohortName = (typeof COHORT_NAMES)[keyof typeof COHORT_NAMES];\n\nexport const BALANCE_CATEGORIES = {\n  RANGE_0_99: '0-99',\n  RANGE_100_999: '100-999',\n  RANGE_1K_9_9K: '1k-9.9k',\n  RANGE_10K_99_9K: '10k-99.9k',\n  RANGE_100K_999_9K: '100k-999.9k',\n  RANGE_1M_PLUS: '1M+',\n} as const;\n\nexport type BalanceCategory =\n  (typeof BALANCE_CATEGORIES)[keyof typeof BALANCE_CATEGORIES];\n\nexport type Cohort = {\n  cohort: string;\n  eligibilityRate: number; // 0-1 probability of being assigned to this cohort\n  priority: number; // lower number = higher priority\n  eligible: boolean;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  canViewEntryModal: boolean;\n  modalType?: ModalType;\n  cohorts: Cohort[];\n  assignedCohort: string | null;\n  hasAssignedCohortExpired: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n  ShieldCohortAssigned: 'shield_cohort_assigned',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n  cohort?: string;\n};\n\nexport type AssignCohortRequest = {\n  cohort: string;\n};\n\nexport type GetSubscriptionsEligibilitiesRequest = {\n  balanceCategory?: BalanceCategory;\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: CancelSubscriptionRequest): 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(\n    request?: GetSubscriptionsEligibilitiesRequest,\n  ): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n  assignUserToCohort(request: AssignCohortRequest): Promise<void>;\n\n  /**\n   * Link rewards to a subscription.\n   */\n  linkRewards(\n    request: LinkRewardsRequest,\n  ): Promise<SubscriptionApiGeneralResponse>;\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  cancelUrl?: 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  useTestClock?: boolean;\n};\n\n/**\n * Request object for linking rewards to a subscription.\n */\nexport type LinkRewardsRequest = {\n  /**\n   * The ID of the reward subscription to be linked to the subscription.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId: CaipAccountId;\n};\n"]}

package/dist/types.d.cts

@@ -25,6 +25,13 @@ export declare const SUBSCRIPTION_STATUSES: {
     readonly paused: "paused";
 };
 export type SubscriptionStatus = (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];
+export declare const CANCEL_TYPES: {
+    readonly ALLOWED_IMMEDIATE: "allowed_immediate";
+    readonly ALLOWED_AT_PERIOD_END: "allowed_at_period_end";
+    readonly NOT_ALLOWED: "not_allowed";
+    readonly NOT_ALLOWED_PENDING_VERIFICATION: "not_allowed_pending_verification";
+};
+export type CancelType = (typeof CANCEL_TYPES)[keyof typeof CANCEL_TYPES];
 export declare const CRYPTO_PAYMENT_METHOD_ERRORS: {
     readonly APPROVAL_TRANSACTION_TOO_OLD: "approval_transaction_too_old";
     readonly APPROVAL_TRANSACTION_REVERTED: "approval_transaction_reverted";
@@ -63,6 +70,8 @@ export type Subscription = {
     endDate?: string;
     /** The date the subscription was canceled. */
     canceledAt?: string;
+    /** The cancellation type indicating what cancellation options are available for this subscription. */
+    cancelType: CancelType;
     /** The date the subscription was marked as inactive (paused/past_due/canceled). */
     inactiveAt?: string;
     /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */
@@ -102,6 +111,7 @@ export type StartSubscriptionRequest = {
     isTrialRequested: boolean;
     recurringInterval: RecurringInterval;
     successUrl?: string;
+    cancelUrl?: string;
     useTestClock?: boolean;
     /**
      * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.
@@ -158,6 +168,11 @@ export type SubscriptionApiGeneralResponse = {
      */
     message?: string;
 };
+export type CancelSubscriptionRequest = {
+    subscriptionId: string;
+    /** Whether to cancel at the end of the current period */
+    cancelAtPeriodEnd?: boolean;
+};
 export type AuthUtils = {
     getAccessToken: () => Promise<string>;
 };
@@ -294,9 +309,7 @@ export type SubmitSponsorshipIntentsRequest = {
 export type SubmitSponsorshipIntentsMethodParams = Pick<SubmitSponsorshipIntentsRequest, 'chainId' | 'address' | 'products'>;
 export type ISubscriptionService = {
     getSubscriptions(): Promise<GetSubscriptionsResponse>;
-    cancelSubscription(request: {
-        subscriptionId: string;
-    }): Promise<Subscription>;
+    cancelSubscription(request: CancelSubscriptionRequest): Promise<Subscription>;
     unCancelSubscription(request: {
         subscriptionId: string;
     }): Promise<Subscription>;
@@ -344,6 +357,7 @@ export type UpdatePaymentMethodCardRequest = {
      */
     recurringInterval: RecurringInterval;
     successUrl?: string;
+    cancelUrl?: string;
 };
 export type UpdatePaymentMethodCardResponse = {
     redirectUrl: string;

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,aAAa,EAAE,GAAG,EAAE,wBAAwB;AAE1D,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,eAAO,MAAM,UAAU;;;CAGb,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAErE,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,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4KAA4K;IAC5K,oBAAoB,EAAE,OAAO,CAAC;IAC9B,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;IAC/B,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,4EAA4E;IAC5E,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,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,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,0BAA0B,EAAE,MAAM,CAAC;CACpC,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;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,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,eAAO,MAAM,YAAY;;;CAGf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB;;;;;;;CAOrB,CAAC;AAEX,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;CAGxB,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;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,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,CAC3B,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACtC,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;OAEG;IACH,WAAW,CACT,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3C;;;;;;;;;;;;;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;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;OAMG;IACH,eAAe,EAAE,aAAa,CAAC;CAChC,CAAC"}
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,wBAAwB;AAE1D,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,YAAY;;;;;CAKf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,4BAA4B;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF,eAAO,MAAM,UAAU;;;CAGb,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAErE,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,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sGAAsG;IACtG,UAAU,EAAE,UAAU,CAAC;IACvB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4KAA4K;IAC5K,oBAAoB,EAAE,OAAO,CAAC;IAC9B,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;IAC/B,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,4EAA4E;IAC5E,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,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,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,0BAA0B,EAAE,MAAM,CAAC;CACpC,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;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,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,eAAO,MAAM,YAAY;;;CAGf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB;;;;;;;CAOrB,CAAC;AAEX,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;CAGxB,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;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,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,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9E,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,CAC3B,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACtC,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;OAEG;IACH,WAAW,CACT,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3C;;;;;;;;;;;;;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;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,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;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;OAMG;IACH,eAAe,EAAE,aAAa,CAAC;CAChC,CAAC"}

package/dist/types.d.mts

@@ -25,6 +25,13 @@ export declare const SUBSCRIPTION_STATUSES: {
     readonly paused: "paused";
 };
 export type SubscriptionStatus = (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];
+export declare const CANCEL_TYPES: {
+    readonly ALLOWED_IMMEDIATE: "allowed_immediate";
+    readonly ALLOWED_AT_PERIOD_END: "allowed_at_period_end";
+    readonly NOT_ALLOWED: "not_allowed";
+    readonly NOT_ALLOWED_PENDING_VERIFICATION: "not_allowed_pending_verification";
+};
+export type CancelType = (typeof CANCEL_TYPES)[keyof typeof CANCEL_TYPES];
 export declare const CRYPTO_PAYMENT_METHOD_ERRORS: {
     readonly APPROVAL_TRANSACTION_TOO_OLD: "approval_transaction_too_old";
     readonly APPROVAL_TRANSACTION_REVERTED: "approval_transaction_reverted";
@@ -63,6 +70,8 @@ export type Subscription = {
     endDate?: string;
     /** The date the subscription was canceled. */
     canceledAt?: string;
+    /** The cancellation type indicating what cancellation options are available for this subscription. */
+    cancelType: CancelType;
     /** The date the subscription was marked as inactive (paused/past_due/canceled). */
     inactiveAt?: string;
     /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */
@@ -102,6 +111,7 @@ export type StartSubscriptionRequest = {
     isTrialRequested: boolean;
     recurringInterval: RecurringInterval;
     successUrl?: string;
+    cancelUrl?: string;
     useTestClock?: boolean;
     /**
      * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.
@@ -158,6 +168,11 @@ export type SubscriptionApiGeneralResponse = {
      */
     message?: string;
 };
+export type CancelSubscriptionRequest = {
+    subscriptionId: string;
+    /** Whether to cancel at the end of the current period */
+    cancelAtPeriodEnd?: boolean;
+};
 export type AuthUtils = {
     getAccessToken: () => Promise<string>;
 };
@@ -294,9 +309,7 @@ export type SubmitSponsorshipIntentsRequest = {
 export type SubmitSponsorshipIntentsMethodParams = Pick<SubmitSponsorshipIntentsRequest, 'chainId' | 'address' | 'products'>;
 export type ISubscriptionService = {
     getSubscriptions(): Promise<GetSubscriptionsResponse>;
-    cancelSubscription(request: {
-        subscriptionId: string;
-    }): Promise<Subscription>;
+    cancelSubscription(request: CancelSubscriptionRequest): Promise<Subscription>;
     unCancelSubscription(request: {
         subscriptionId: string;
     }): Promise<Subscription>;
@@ -344,6 +357,7 @@ export type UpdatePaymentMethodCardRequest = {
      */
     recurringInterval: RecurringInterval;
     successUrl?: string;
+    cancelUrl?: string;
 };
 export type UpdatePaymentMethodCardResponse = {
     redirectUrl: string;

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,aAAa,EAAE,GAAG,EAAE,wBAAwB;AAE1D,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,eAAO,MAAM,UAAU;;;CAGb,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAErE,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,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4KAA4K;IAC5K,oBAAoB,EAAE,OAAO,CAAC;IAC9B,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;IAC/B,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,4EAA4E;IAC5E,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,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,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,0BAA0B,EAAE,MAAM,CAAC;CACpC,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;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,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,eAAO,MAAM,YAAY;;;CAGf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB;;;;;;;CAOrB,CAAC;AAEX,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;CAGxB,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;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,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,CAC3B,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACtC,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;OAEG;IACH,WAAW,CACT,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3C;;;;;;;;;;;;;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;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;OAMG;IACH,eAAe,EAAE,aAAa,CAAC;CAChC,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,wBAAwB;AAE1D,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,YAAY;;;;;CAKf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,4BAA4B;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF,eAAO,MAAM,UAAU;;;CAGb,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAErE,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,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sGAAsG;IACtG,UAAU,EAAE,UAAU,CAAC;IACvB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4KAA4K;IAC5K,oBAAoB,EAAE,OAAO,CAAC;IAC9B,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;IAC/B,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,4EAA4E;IAC5E,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,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,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,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,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,0BAA0B,EAAE,MAAM,CAAC;CACpC,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;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,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,eAAO,MAAM,YAAY;;;CAGf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB;;;;;;;CAOrB,CAAC;AAEX,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;CAGxB,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;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,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,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9E,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,CAC3B,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACtC,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;OAEG;IACH,WAAW,CACT,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3C;;;;;;;;;;;;;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;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,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;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;OAMG;IACH,eAAe,EAAE,aAAa,CAAC;CAChC,CAAC"}

package/dist/types.mjs

@@ -25,6 +25,12 @@ export const SUBSCRIPTION_STATUSES = {
     // Paused states
     paused: 'paused',
 };
+export const CANCEL_TYPES = {
+    ALLOWED_IMMEDIATE: 'allowed_immediate',
+    ALLOWED_AT_PERIOD_END: 'allowed_at_period_end',
+    NOT_ALLOWED: 'not_allowed',
+    NOT_ALLOWED_PENDING_VERIFICATION: 'not_allowed_pending_verification',
+};
 export const CRYPTO_PAYMENT_METHOD_ERRORS = {
     APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',
     APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',

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;AAKX,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACE,CAAC;AAmOX,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAIX,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,SAAS;IACxB,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,iBAAiB,EAAE,aAAa;IAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAsBX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;IACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC","sourcesContent":["import type { CaipAccountId, 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\nexport const MODAL_TYPE = {\n  A: 'A',\n  B: 'B',\n} as const;\n\nexport type ModalType = (typeof MODAL_TYPE)[keyof typeof MODAL_TYPE];\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  /** The date the subscription was canceled. */\n  canceledAt?: string; // ISO 8601\n  /** The date the subscription was marked as inactive (paused/past_due/canceled). */\n  inactiveAt?: string; // ISO 8601\n  /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */\n  isEligibleForSupport: boolean;\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  /** The last subscription that user has subscribed to if any. */\n  lastSubscription?: Subscription;\n  /** The reward account ID if user has linked rewards to the subscription. */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  useTestClock?: boolean;\n\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\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  useTestClock?: boolean;\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\n/**\n * General response type for the subscription API requests\n * which doesn't require any specific response data.\n */\nexport type SubscriptionApiGeneralResponse = {\n  /**\n   * Whether the request was successful.\n   */\n  success: boolean;\n  /**\n   * The message of the response.\n   */\n  message?: string;\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  /** min billing cycles for approval */\n  minBillingCycles: number;\n  /** min billing cycles for account balance check */\n  minBillingCyclesForBalance: 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   * Whether the chain supports sponsorship for the trialed subscription approval transaction.\n   * This is used to determine if the user can be sponsored for the gas fees for the trialed subscription approval transaction.\n   */\n  isSponsorshipSupported?: boolean;\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 const COHORT_NAMES = {\n  POST_TX: 'post_tx',\n  WALLET_HOME: 'wallet_home',\n} as const;\n\nexport type CohortName = (typeof COHORT_NAMES)[keyof typeof COHORT_NAMES];\n\nexport const BALANCE_CATEGORIES = {\n  RANGE_0_99: '0-99',\n  RANGE_100_999: '100-999',\n  RANGE_1K_9_9K: '1k-9.9k',\n  RANGE_10K_99_9K: '10k-99.9k',\n  RANGE_100K_999_9K: '100k-999.9k',\n  RANGE_1M_PLUS: '1M+',\n} as const;\n\nexport type BalanceCategory =\n  (typeof BALANCE_CATEGORIES)[keyof typeof BALANCE_CATEGORIES];\n\nexport type Cohort = {\n  cohort: string;\n  eligibilityRate: number; // 0-1 probability of being assigned to this cohort\n  priority: number; // lower number = higher priority\n  eligible: boolean;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  canViewEntryModal: boolean;\n  modalType?: ModalType;\n  cohorts: Cohort[];\n  assignedCohort: string | null;\n  hasAssignedCohortExpired: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n  ShieldCohortAssigned: 'shield_cohort_assigned',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n  cohort?: string;\n};\n\nexport type AssignCohortRequest = {\n  cohort: string;\n};\n\nexport type GetSubscriptionsEligibilitiesRequest = {\n  balanceCategory?: BalanceCategory;\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(\n    request?: GetSubscriptionsEligibilitiesRequest,\n  ): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n  assignUserToCohort(request: AssignCohortRequest): Promise<void>;\n\n  /**\n   * Link rewards to a subscription.\n   */\n  linkRewards(\n    request: LinkRewardsRequest,\n  ): Promise<SubscriptionApiGeneralResponse>;\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  useTestClock?: boolean;\n};\n\n/**\n * Request object for linking rewards to a subscription.\n */\nexport type LinkRewardsRequest = {\n  /**\n   * The ID of the reward subscription to be linked to the subscription.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId: CaipAccountId;\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,YAAY,GAAG;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,WAAW,EAAE,aAAa;IAC1B,gCAAgC,EAAE,kCAAkC;CAC5D,CAAC;AAIX,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;AAKX,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACE,CAAC;AA4OX,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAIX,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,SAAS;IACxB,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,iBAAiB,EAAE,aAAa;IAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAsBX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;IACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC","sourcesContent":["import type { CaipAccountId, 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 CANCEL_TYPES = {\n  ALLOWED_IMMEDIATE: 'allowed_immediate',\n  ALLOWED_AT_PERIOD_END: 'allowed_at_period_end',\n  NOT_ALLOWED: 'not_allowed',\n  NOT_ALLOWED_PENDING_VERIFICATION: 'not_allowed_pending_verification',\n} as const;\n\nexport type CancelType = (typeof CANCEL_TYPES)[keyof typeof CANCEL_TYPES];\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\nexport const MODAL_TYPE = {\n  A: 'A',\n  B: 'B',\n} as const;\n\nexport type ModalType = (typeof MODAL_TYPE)[keyof typeof MODAL_TYPE];\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  /** The date the subscription was canceled. */\n  canceledAt?: string; // ISO 8601\n  /** The cancellation type indicating what cancellation options are available for this subscription. */\n  cancelType: CancelType;\n  /** The date the subscription was marked as inactive (paused/past_due/canceled). */\n  inactiveAt?: string; // ISO 8601\n  /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */\n  isEligibleForSupport: boolean;\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  /** The last subscription that user has subscribed to if any. */\n  lastSubscription?: Subscription;\n  /** The reward account ID if user has linked rewards to the subscription. */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  cancelUrl?: string;\n  useTestClock?: boolean;\n\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\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  useTestClock?: boolean;\n  /**\n   * The optional ID of the reward subscription to be opt in along with the main `shield` subscription.\n   * This is required if user wants to opt in to the reward subscription during the `shield` subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\n/**\n * General response type for the subscription API requests\n * which doesn't require any specific response data.\n */\nexport type SubscriptionApiGeneralResponse = {\n  /**\n   * Whether the request was successful.\n   */\n  success: boolean;\n  /**\n   * The message of the response.\n   */\n  message?: string;\n};\n\nexport type CancelSubscriptionRequest = {\n  subscriptionId: string;\n  /** Whether to cancel at the end of the current period */\n  cancelAtPeriodEnd?: boolean;\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  /** min billing cycles for approval */\n  minBillingCycles: number;\n  /** min billing cycles for account balance check */\n  minBillingCyclesForBalance: 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   * Whether the chain supports sponsorship for the trialed subscription approval transaction.\n   * This is used to determine if the user can be sponsored for the gas fees for the trialed subscription approval transaction.\n   */\n  isSponsorshipSupported?: boolean;\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 const COHORT_NAMES = {\n  POST_TX: 'post_tx',\n  WALLET_HOME: 'wallet_home',\n} as const;\n\nexport type CohortName = (typeof COHORT_NAMES)[keyof typeof COHORT_NAMES];\n\nexport const BALANCE_CATEGORIES = {\n  RANGE_0_99: '0-99',\n  RANGE_100_999: '100-999',\n  RANGE_1K_9_9K: '1k-9.9k',\n  RANGE_10K_99_9K: '10k-99.9k',\n  RANGE_100K_999_9K: '100k-999.9k',\n  RANGE_1M_PLUS: '1M+',\n} as const;\n\nexport type BalanceCategory =\n  (typeof BALANCE_CATEGORIES)[keyof typeof BALANCE_CATEGORIES];\n\nexport type Cohort = {\n  cohort: string;\n  eligibilityRate: number; // 0-1 probability of being assigned to this cohort\n  priority: number; // lower number = higher priority\n  eligible: boolean;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  canViewEntryModal: boolean;\n  modalType?: ModalType;\n  cohorts: Cohort[];\n  assignedCohort: string | null;\n  hasAssignedCohortExpired: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n  ShieldCohortAssigned: 'shield_cohort_assigned',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n  cohort?: string;\n};\n\nexport type AssignCohortRequest = {\n  cohort: string;\n};\n\nexport type GetSubscriptionsEligibilitiesRequest = {\n  balanceCategory?: BalanceCategory;\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: CancelSubscriptionRequest): 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(\n    request?: GetSubscriptionsEligibilitiesRequest,\n  ): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n  assignUserToCohort(request: AssignCohortRequest): Promise<void>;\n\n  /**\n   * Link rewards to a subscription.\n   */\n  linkRewards(\n    request: LinkRewardsRequest,\n  ): Promise<SubscriptionApiGeneralResponse>;\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  cancelUrl?: 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  useTestClock?: boolean;\n};\n\n/**\n * Request object for linking rewards to a subscription.\n */\nexport type LinkRewardsRequest = {\n  /**\n   * The ID of the reward subscription to be linked to the subscription.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId: CaipAccountId;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/subscription-controller",
-  "version": "5.4.0-preview-766f7065",
+  "version": "5.4.1-preview-cd0d0950",
   "description": "Handle user subscription",
   "keywords": [
     "MetaMask",
@@ -53,7 +53,7 @@
     "@metamask/messenger": "^0.3.0",
     "@metamask/polling-controller": "^16.0.2",
     "@metamask/profile-sync-controller": "^27.0.0",
-    "@metamask/transaction-controller": "^62.9.2",
+    "@metamask/transaction-controller": "^62.10.0",
     "@metamask/utils": "^11.9.0",
     "bignumber.js": "^9.1.2"
   },