@metamask-previews/subscription-controller 6.2.2-preview-58a4a8b71 → 6.2.2-preview-4c8a5dfcb

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

@@ -0,0 +1,151 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { SubscriptionService } from "./SubscriptionService.mjs";
+/**
+ * Fetches the user's subscriptions.
+ *
+ * @returns The subscriptions response.
+ */
+export type SubscriptionServiceGetSubscriptionsAction = {
+    type: `SubscriptionService:getSubscriptions`;
+    handler: SubscriptionService['getSubscriptions'];
+};
+/**
+ * Cancels a subscription.
+ *
+ * @param params - The cancel subscription request.
+ * @returns The updated subscription.
+ */
+export type SubscriptionServiceCancelSubscriptionAction = {
+    type: `SubscriptionService:cancelSubscription`;
+    handler: SubscriptionService['cancelSubscription'];
+};
+/**
+ * Reverses a pending subscription cancellation.
+ *
+ * @param params - The uncancel subscription request.
+ * @param params.subscriptionId - The subscription ID to uncancel.
+ * @returns The updated subscription.
+ */
+export type SubscriptionServiceUnCancelSubscriptionAction = {
+    type: `SubscriptionService:unCancelSubscription`;
+    handler: SubscriptionService['unCancelSubscription'];
+};
+/**
+ * Starts a subscription with a card payment method.
+ *
+ * @param request - The start subscription request.
+ * @returns The checkout session response.
+ */
+export type SubscriptionServiceStartSubscriptionWithCardAction = {
+    type: `SubscriptionService:startSubscriptionWithCard`;
+    handler: SubscriptionService['startSubscriptionWithCard'];
+};
+/**
+ * Starts a subscription with a crypto payment method.
+ *
+ * @param request - The start crypto subscription request.
+ * @returns The created subscription response.
+ */
+export type SubscriptionServiceStartSubscriptionWithCryptoAction = {
+    type: `SubscriptionService:startSubscriptionWithCrypto`;
+    handler: SubscriptionService['startSubscriptionWithCrypto'];
+};
+/**
+ * Updates a subscription's card payment method.
+ *
+ * @param request - The update payment method request.
+ * @returns The redirect URL response.
+ */
+export type SubscriptionServiceUpdatePaymentMethodCardAction = {
+    type: `SubscriptionService:updatePaymentMethodCard`;
+    handler: SubscriptionService['updatePaymentMethodCard'];
+};
+/**
+ * Updates a subscription's crypto payment method.
+ *
+ * @param request - The update payment method request.
+ */
+export type SubscriptionServiceUpdatePaymentMethodCryptoAction = {
+    type: `SubscriptionService:updatePaymentMethodCrypto`;
+    handler: SubscriptionService['updatePaymentMethodCrypto'];
+};
+/**
+ * Get the eligibility for a shield subscription.
+ *
+ * @param request - Optional request object containing user balance category to check cohort eligibility
+ * @returns The eligibility for a shield subscription
+ */
+export type SubscriptionServiceGetSubscriptionsEligibilitiesAction = {
+    type: `SubscriptionService:getSubscriptionsEligibilities`;
+    handler: SubscriptionService['getSubscriptionsEligibilities'];
+};
+/**
+ * Submit a user event. (e.g. shield modal viewed)
+ *
+ * @param request - Request object containing the event to submit.
+ * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }
+ */
+export type SubscriptionServiceSubmitUserEventAction = {
+    type: `SubscriptionService:submitUserEvent`;
+    handler: SubscriptionService['submitUserEvent'];
+};
+/**
+ * Assign user to a cohort.
+ *
+ * @param request - Request object containing the cohort to assign the user to.
+ * @example { cohort: 'post_tx' }
+ */
+export type SubscriptionServiceAssignUserToCohortAction = {
+    type: `SubscriptionService:assignUserToCohort`;
+    handler: SubscriptionService['assignUserToCohort'];
+};
+/**
+ * Submit sponsorship intents to the Subscription Service backend.
+ *
+ * This is intended to be used together with the crypto subscription flow.
+ * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.
+ *
+ * @param request - Request object containing the address and products.
+ * @example { address: '0x1234567890123456789012345678901234567890', products: [ProductType.Shield] }
+ */
+export type SubscriptionServiceSubmitSponsorshipIntentsAction = {
+    type: `SubscriptionService:submitSponsorshipIntents`;
+    handler: SubscriptionService['submitSponsorshipIntents'];
+};
+/**
+ * Link rewards to a subscription.
+ *
+ * @param request - Request object containing the reward account ID.
+ * @example { rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }
+ * @returns The response from the API.
+ */
+export type SubscriptionServiceLinkRewardsAction = {
+    type: `SubscriptionService:linkRewards`;
+    handler: SubscriptionService['linkRewards'];
+};
+/**
+ * Fetches subscription pricing information.
+ *
+ * @returns The pricing response.
+ */
+export type SubscriptionServiceGetPricingAction = {
+    type: `SubscriptionService:getPricing`;
+    handler: SubscriptionService['getPricing'];
+};
+/**
+ * Fetches the billing portal URL.
+ *
+ * @returns The billing portal response.
+ */
+export type SubscriptionServiceGetBillingPortalUrlAction = {
+    type: `SubscriptionService:getBillingPortalUrl`;
+    handler: SubscriptionService['getBillingPortalUrl'];
+};
+/**
+ * Union of all SubscriptionService action types.
+ */
+export type SubscriptionServiceMethodActions = SubscriptionServiceGetSubscriptionsAction | SubscriptionServiceCancelSubscriptionAction | SubscriptionServiceUnCancelSubscriptionAction | SubscriptionServiceStartSubscriptionWithCardAction | SubscriptionServiceStartSubscriptionWithCryptoAction | SubscriptionServiceUpdatePaymentMethodCardAction | SubscriptionServiceUpdatePaymentMethodCryptoAction | SubscriptionServiceGetSubscriptionsEligibilitiesAction | SubscriptionServiceSubmitUserEventAction | SubscriptionServiceAssignUserToCohortAction | SubscriptionServiceSubmitSponsorshipIntentsAction | SubscriptionServiceLinkRewardsAction | SubscriptionServiceGetPricingAction | SubscriptionServiceGetBillingPortalUrlAction;
+//# sourceMappingURL=SubscriptionService-method-action-types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionService-method-action-types.d.mts","sourceRoot":"","sources":["../src/SubscriptionService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAiC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,mBAAmB,CAAC,2BAA2B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,mBAAmB,CAAC,6BAA6B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,mBAAmB,CAAC,2BAA2B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,mBAAmB,CAAC,+BAA+B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,mBAAmB,CAAC,0BAA0B,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,yCAAyC,GACzC,2CAA2C,GAC3C,6CAA6C,GAC7C,kDAAkD,GAClD,oDAAoD,GACpD,gDAAgD,GAChD,kDAAkD,GAClD,sDAAsD,GACtD,wCAAwC,GACxC,2CAA2C,GAC3C,iDAAiD,GACjD,oCAAoC,GACpC,mCAAmC,GACnC,4CAA4C,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionService-method-action-types.mjs","sourceRoot":"","sources":["../src/SubscriptionService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SubscriptionService } from './SubscriptionService.js';\n\n/**\n * Fetches the user's subscriptions.\n *\n * @returns The subscriptions response.\n */\nexport type SubscriptionServiceGetSubscriptionsAction = {\n  type: `SubscriptionService:getSubscriptions`;\n  handler: SubscriptionService['getSubscriptions'];\n};\n\n/**\n * Cancels a subscription.\n *\n * @param params - The cancel subscription request.\n * @returns The updated subscription.\n */\nexport type SubscriptionServiceCancelSubscriptionAction = {\n  type: `SubscriptionService:cancelSubscription`;\n  handler: SubscriptionService['cancelSubscription'];\n};\n\n/**\n * Reverses a pending subscription cancellation.\n *\n * @param params - The uncancel subscription request.\n * @param params.subscriptionId - The subscription ID to uncancel.\n * @returns The updated subscription.\n */\nexport type SubscriptionServiceUnCancelSubscriptionAction = {\n  type: `SubscriptionService:unCancelSubscription`;\n  handler: SubscriptionService['unCancelSubscription'];\n};\n\n/**\n * Starts a subscription with a card payment method.\n *\n * @param request - The start subscription request.\n * @returns The checkout session response.\n */\nexport type SubscriptionServiceStartSubscriptionWithCardAction = {\n  type: `SubscriptionService:startSubscriptionWithCard`;\n  handler: SubscriptionService['startSubscriptionWithCard'];\n};\n\n/**\n * Starts a subscription with a crypto payment method.\n *\n * @param request - The start crypto subscription request.\n * @returns The created subscription response.\n */\nexport type SubscriptionServiceStartSubscriptionWithCryptoAction = {\n  type: `SubscriptionService:startSubscriptionWithCrypto`;\n  handler: SubscriptionService['startSubscriptionWithCrypto'];\n};\n\n/**\n * Updates a subscription's card payment method.\n *\n * @param request - The update payment method request.\n * @returns The redirect URL response.\n */\nexport type SubscriptionServiceUpdatePaymentMethodCardAction = {\n  type: `SubscriptionService:updatePaymentMethodCard`;\n  handler: SubscriptionService['updatePaymentMethodCard'];\n};\n\n/**\n * Updates a subscription's crypto payment method.\n *\n * @param request - The update payment method request.\n */\nexport type SubscriptionServiceUpdatePaymentMethodCryptoAction = {\n  type: `SubscriptionService:updatePaymentMethodCrypto`;\n  handler: SubscriptionService['updatePaymentMethodCrypto'];\n};\n\n/**\n * Get the eligibility for a shield subscription.\n *\n * @param request - Optional request object containing user balance category to check cohort eligibility\n * @returns The eligibility for a shield subscription\n */\nexport type SubscriptionServiceGetSubscriptionsEligibilitiesAction = {\n  type: `SubscriptionService:getSubscriptionsEligibilities`;\n  handler: SubscriptionService['getSubscriptionsEligibilities'];\n};\n\n/**\n * Submit a user event. (e.g. shield modal viewed)\n *\n * @param request - Request object containing the event to submit.\n * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }\n */\nexport type SubscriptionServiceSubmitUserEventAction = {\n  type: `SubscriptionService:submitUserEvent`;\n  handler: SubscriptionService['submitUserEvent'];\n};\n\n/**\n * Assign user to a cohort.\n *\n * @param request - Request object containing the cohort to assign the user to.\n * @example { cohort: 'post_tx' }\n */\nexport type SubscriptionServiceAssignUserToCohortAction = {\n  type: `SubscriptionService:assignUserToCohort`;\n  handler: SubscriptionService['assignUserToCohort'];\n};\n\n/**\n * Submit sponsorship intents to the Subscription Service backend.\n *\n * This is intended to be used together with the crypto subscription flow.\n * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.\n *\n * @param request - Request object containing the address and products.\n * @example { address: '0x1234567890123456789012345678901234567890', products: [ProductType.Shield] }\n */\nexport type SubscriptionServiceSubmitSponsorshipIntentsAction = {\n  type: `SubscriptionService:submitSponsorshipIntents`;\n  handler: SubscriptionService['submitSponsorshipIntents'];\n};\n\n/**\n * Link rewards to a subscription.\n *\n * @param request - Request object containing the reward account ID.\n * @example { rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }\n * @returns The response from the API.\n */\nexport type SubscriptionServiceLinkRewardsAction = {\n  type: `SubscriptionService:linkRewards`;\n  handler: SubscriptionService['linkRewards'];\n};\n\n/**\n * Fetches subscription pricing information.\n *\n * @returns The pricing response.\n */\nexport type SubscriptionServiceGetPricingAction = {\n  type: `SubscriptionService:getPricing`;\n  handler: SubscriptionService['getPricing'];\n};\n\n/**\n * Fetches the billing portal URL.\n *\n * @returns The billing portal response.\n */\nexport type SubscriptionServiceGetBillingPortalUrlAction = {\n  type: `SubscriptionService:getBillingPortalUrl`;\n  handler: SubscriptionService['getBillingPortalUrl'];\n};\n\n/**\n * Union of all SubscriptionService action types.\n */\nexport type SubscriptionServiceMethodActions =\n  | SubscriptionServiceGetSubscriptionsAction\n  | SubscriptionServiceCancelSubscriptionAction\n  | SubscriptionServiceUnCancelSubscriptionAction\n  | SubscriptionServiceStartSubscriptionWithCardAction\n  | SubscriptionServiceStartSubscriptionWithCryptoAction\n  | SubscriptionServiceUpdatePaymentMethodCardAction\n  | SubscriptionServiceUpdatePaymentMethodCryptoAction\n  | SubscriptionServiceGetSubscriptionsEligibilitiesAction\n  | SubscriptionServiceSubmitUserEventAction\n  | SubscriptionServiceAssignUserToCohortAction\n  | SubscriptionServiceSubmitSponsorshipIntentsAction\n  | SubscriptionServiceLinkRewardsAction\n  | SubscriptionServiceGetPricingAction\n  | SubscriptionServiceGetBillingPortalUrlAction;\n"]}

package/dist/SubscriptionService-structs.cjs

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionEligibilityArrayStruct = exports.SubscriptionEligibilityStruct = exports.PricingResponseStruct = exports.SubscriptionApiGeneralResponseStruct = exports.BillingPortalResponseStruct = exports.UpdatePaymentMethodCardResponseStruct = exports.StartCryptoSubscriptionResponseStruct = exports.StartSubscriptionResponseStruct = exports.GetSubscriptionsResponseStruct = exports.SubscriptionStruct = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const types_js_1 = require("./types.cjs");
+const ProductTypeStruct = (0, superstruct_1.enums)(Object.values(types_js_1.PRODUCT_TYPES));
+const PaymentTypeStruct = (0, superstruct_1.enums)(Object.values(types_js_1.PAYMENT_TYPES));
+const RecurringIntervalStruct = (0, superstruct_1.enums)(Object.values(types_js_1.RECURRING_INTERVALS));
+const SubscriptionStatusStruct = (0, superstruct_1.enums)(Object.values(types_js_1.SUBSCRIPTION_STATUSES));
+const CancelTypeStruct = (0, superstruct_1.enums)(Object.values(types_js_1.CANCEL_TYPES));
+const CryptoPaymentMethodErrorStruct = (0, superstruct_1.enums)(Object.values(types_js_1.CRYPTO_PAYMENT_METHOD_ERRORS));
+const ProductStruct = (0, superstruct_1.type)({
+    name: ProductTypeStruct,
+    currency: (0, superstruct_1.enums)(['usd']),
+    unitAmount: (0, superstruct_1.number)(),
+    unitDecimals: (0, superstruct_1.number)(),
+});
+const SubscriptionCardPaymentMethodStruct = (0, superstruct_1.type)({
+    type: (0, superstruct_1.enums)([types_js_1.PAYMENT_TYPES.byCard]),
+    card: (0, superstruct_1.type)({
+        brand: (0, superstruct_1.string)(),
+        displayBrand: (0, superstruct_1.string)(),
+        last4: (0, superstruct_1.string)(),
+    }),
+});
+const SubscriptionCryptoPaymentMethodStruct = (0, superstruct_1.type)({
+    type: (0, superstruct_1.enums)([types_js_1.PAYMENT_TYPES.byCrypto]),
+    crypto: (0, superstruct_1.type)({
+        payerAddress: utils_1.StrictHexStruct,
+        chainId: utils_1.StrictHexStruct,
+        tokenSymbol: (0, superstruct_1.string)(),
+        error: (0, superstruct_1.optional)(CryptoPaymentMethodErrorStruct),
+    }),
+});
+const SubscriptionPaymentMethodStruct = (0, superstruct_1.union)([
+    SubscriptionCardPaymentMethodStruct,
+    SubscriptionCryptoPaymentMethodStruct,
+]);
+exports.SubscriptionStruct = (0, superstruct_1.type)({
+    id: (0, superstruct_1.string)(),
+    products: (0, superstruct_1.array)(ProductStruct),
+    currentPeriodStart: (0, superstruct_1.string)(),
+    currentPeriodEnd: (0, superstruct_1.string)(),
+    cancelAtPeriodEnd: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+    status: SubscriptionStatusStruct,
+    interval: RecurringIntervalStruct,
+    paymentMethod: SubscriptionPaymentMethodStruct,
+    trialPeriodDays: (0, superstruct_1.optional)((0, superstruct_1.number)()),
+    trialStart: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    trialEnd: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    endDate: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    canceledAt: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    cancelType: CancelTypeStruct,
+    inactiveAt: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    isEligibleForSupport: (0, superstruct_1.boolean)(),
+    billingCycles: (0, superstruct_1.optional)((0, superstruct_1.number)()),
+});
+exports.GetSubscriptionsResponseStruct = (0, superstruct_1.type)({
+    customerId: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    subscriptions: (0, superstruct_1.array)(exports.SubscriptionStruct),
+    trialedProducts: (0, superstruct_1.array)(ProductTypeStruct),
+    lastSubscription: (0, superstruct_1.optional)(exports.SubscriptionStruct),
+    rewardAccountId: (0, superstruct_1.optional)(utils_1.CaipAccountIdStruct),
+});
+exports.StartSubscriptionResponseStruct = (0, superstruct_1.type)({
+    checkoutSessionUrl: (0, superstruct_1.string)(),
+});
+exports.StartCryptoSubscriptionResponseStruct = (0, superstruct_1.type)({
+    subscriptionId: (0, superstruct_1.string)(),
+    status: SubscriptionStatusStruct,
+});
+exports.UpdatePaymentMethodCardResponseStruct = (0, superstruct_1.type)({
+    redirectUrl: (0, superstruct_1.string)(),
+});
+exports.BillingPortalResponseStruct = (0, superstruct_1.type)({
+    url: (0, superstruct_1.string)(),
+});
+exports.SubscriptionApiGeneralResponseStruct = (0, superstruct_1.type)({
+    success: (0, superstruct_1.boolean)(),
+    message: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+});
+const ProductPriceStruct = (0, superstruct_1.type)({
+    interval: RecurringIntervalStruct,
+    unitAmount: (0, superstruct_1.number)(),
+    unitDecimals: (0, superstruct_1.number)(),
+    currency: (0, superstruct_1.enums)(['usd']),
+    trialPeriodDays: (0, superstruct_1.number)(),
+    minBillingCycles: (0, superstruct_1.number)(),
+    minBillingCyclesForBalance: (0, superstruct_1.number)(),
+});
+const ProductPricingStruct = (0, superstruct_1.type)({
+    name: ProductTypeStruct,
+    prices: (0, superstruct_1.array)(ProductPriceStruct),
+});
+const TokenPaymentInfoStruct = (0, superstruct_1.type)({
+    symbol: (0, superstruct_1.string)(),
+    address: utils_1.StrictHexStruct,
+    decimals: (0, superstruct_1.number)(),
+    conversionRate: (0, superstruct_1.type)({
+        usd: (0, superstruct_1.string)(),
+    }),
+});
+const ChainPaymentInfoStruct = (0, superstruct_1.type)({
+    chainId: utils_1.StrictHexStruct,
+    paymentAddress: utils_1.StrictHexStruct,
+    tokens: (0, superstruct_1.array)(TokenPaymentInfoStruct),
+    isSponsorshipSupported: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+});
+const PricingPaymentMethodStruct = (0, superstruct_1.type)({
+    type: PaymentTypeStruct,
+    chains: (0, superstruct_1.optional)((0, superstruct_1.array)(ChainPaymentInfoStruct)),
+});
+exports.PricingResponseStruct = (0, superstruct_1.type)({
+    products: (0, superstruct_1.array)(ProductPricingStruct),
+    paymentMethods: (0, superstruct_1.array)(PricingPaymentMethodStruct),
+});
+const CohortStruct = (0, superstruct_1.type)({
+    cohort: (0, superstruct_1.string)(),
+    eligibilityRate: (0, superstruct_1.number)(),
+    priority: (0, superstruct_1.number)(),
+    eligible: (0, superstruct_1.boolean)(),
+});
+exports.SubscriptionEligibilityStruct = (0, superstruct_1.type)({
+    product: ProductTypeStruct,
+    canSubscribe: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+    canViewEntryModal: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+    modalType: (0, superstruct_1.optional)((0, superstruct_1.enums)(['A', 'B'])),
+    cohorts: (0, superstruct_1.optional)((0, superstruct_1.array)(CohortStruct)),
+    assignedCohort: (0, superstruct_1.optional)((0, superstruct_1.nullable)((0, superstruct_1.string)())),
+    assignedAt: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    hasAssignedCohortExpired: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+});
+exports.SubscriptionEligibilityArrayStruct = (0, superstruct_1.array)(exports.SubscriptionEligibilityStruct);
+//# sourceMappingURL=SubscriptionService-structs.cjs.map

package/dist/SubscriptionService-structs.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionService-structs.cjs","sourceRoot":"","sources":["../src/SubscriptionService-structs.ts"],"names":[],"mappings":";;;AAAA,uDAU+B;AAC/B,2CAAuE;AAEvE,0CAOoB;AAEpB,MAAM,iBAAiB,GAAG,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,wBAAa,CAAC,CAAC,CAAC;AAC9D,MAAM,iBAAiB,GAAG,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,wBAAa,CAAC,CAAC,CAAC;AAC9D,MAAM,uBAAuB,GAAG,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,8BAAmB,CAAC,CAAC,CAAC;AAC1E,MAAM,wBAAwB,GAAG,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,gCAAqB,CAAC,CAAC,CAAC;AAC7E,MAAM,gBAAgB,GAAG,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,uBAAY,CAAC,CAAC,CAAC;AAC5D,MAAM,8BAA8B,GAAG,IAAA,mBAAK,EAC1C,MAAM,CAAC,MAAM,CAAC,uCAA4B,CAAC,CAC5C,CAAC;AAEF,MAAM,aAAa,GAAG,IAAA,kBAAI,EAAC;IACzB,IAAI,EAAE,iBAAiB;IACvB,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,KAAK,CAAC,CAAC;IACxB,UAAU,EAAE,IAAA,oBAAM,GAAE;IACpB,YAAY,EAAE,IAAA,oBAAM,GAAE;CACvB,CAAC,CAAC;AAEH,MAAM,mCAAmC,GAAG,IAAA,kBAAI,EAAC;IAC/C,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,wBAAa,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE,IAAA,kBAAI,EAAC;QACT,KAAK,EAAE,IAAA,oBAAM,GAAE;QACf,YAAY,EAAE,IAAA,oBAAM,GAAE;QACtB,KAAK,EAAE,IAAA,oBAAM,GAAE;KAChB,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,qCAAqC,GAAG,IAAA,kBAAI,EAAC;IACjD,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,wBAAa,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE,IAAA,kBAAI,EAAC;QACX,YAAY,EAAE,uBAAe;QAC7B,OAAO,EAAE,uBAAe;QACxB,WAAW,EAAE,IAAA,oBAAM,GAAE;QACrB,KAAK,EAAE,IAAA,sBAAQ,EAAC,8BAA8B,CAAC;KAChD,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,+BAA+B,GAAG,IAAA,mBAAK,EAAC;IAC5C,mCAAmC;IACnC,qCAAqC;CACtC,CAAC,CAAC;AAEU,QAAA,kBAAkB,GAAG,IAAA,kBAAI,EAAC;IACrC,EAAE,EAAE,IAAA,oBAAM,GAAE;IACZ,QAAQ,EAAE,IAAA,mBAAK,EAAC,aAAa,CAAC;IAC9B,kBAAkB,EAAE,IAAA,oBAAM,GAAE;IAC5B,gBAAgB,EAAE,IAAA,oBAAM,GAAE;IAC1B,iBAAiB,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IACtC,MAAM,EAAE,wBAAwB;IAChC,QAAQ,EAAE,uBAAuB;IACjC,aAAa,EAAE,+BAA+B;IAC9C,eAAe,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACnC,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,QAAQ,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC5B,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC3B,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,oBAAoB,EAAE,IAAA,qBAAO,GAAE;IAC/B,aAAa,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAClC,CAAC,CAAC;AAEU,QAAA,8BAA8B,GAAG,IAAA,kBAAI,EAAC;IACjD,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,aAAa,EAAE,IAAA,mBAAK,EAAC,0BAAkB,CAAC;IACxC,eAAe,EAAE,IAAA,mBAAK,EAAC,iBAAiB,CAAC;IACzC,gBAAgB,EAAE,IAAA,sBAAQ,EAAC,0BAAkB,CAAC;IAC9C,eAAe,EAAE,IAAA,sBAAQ,EAAC,2BAAmB,CAAC;CAC/C,CAAC,CAAC;AAEU,QAAA,+BAA+B,GAAG,IAAA,kBAAI,EAAC;IAClD,kBAAkB,EAAE,IAAA,oBAAM,GAAE;CAC7B,CAAC,CAAC;AAEU,QAAA,qCAAqC,GAAG,IAAA,kBAAI,EAAC;IACxD,cAAc,EAAE,IAAA,oBAAM,GAAE;IACxB,MAAM,EAAE,wBAAwB;CACjC,CAAC,CAAC;AAEU,QAAA,qCAAqC,GAAG,IAAA,kBAAI,EAAC;IACxD,WAAW,EAAE,IAAA,oBAAM,GAAE;CACtB,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,IAAA,kBAAI,EAAC;IAC9C,GAAG,EAAE,IAAA,oBAAM,GAAE;CACd,CAAC,CAAC;AAEU,QAAA,oCAAoC,GAAG,IAAA,kBAAI,EAAC;IACvD,OAAO,EAAE,IAAA,qBAAO,GAAE;IAClB,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC5B,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,IAAA,kBAAI,EAAC;IAC9B,QAAQ,EAAE,uBAAuB;IACjC,UAAU,EAAE,IAAA,oBAAM,GAAE;IACpB,YAAY,EAAE,IAAA,oBAAM,GAAE;IACtB,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,KAAK,CAAC,CAAC;IACxB,eAAe,EAAE,IAAA,oBAAM,GAAE;IACzB,gBAAgB,EAAE,IAAA,oBAAM,GAAE;IAC1B,0BAA0B,EAAE,IAAA,oBAAM,GAAE;CACrC,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,IAAA,kBAAI,EAAC;IAChC,IAAI,EAAE,iBAAiB;IACvB,MAAM,EAAE,IAAA,mBAAK,EAAC,kBAAkB,CAAC;CAClC,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,IAAA,kBAAI,EAAC;IAClC,MAAM,EAAE,IAAA,oBAAM,GAAE;IAChB,OAAO,EAAE,uBAAe;IACxB,QAAQ,EAAE,IAAA,oBAAM,GAAE;IAClB,cAAc,EAAE,IAAA,kBAAI,EAAC;QACnB,GAAG,EAAE,IAAA,oBAAM,GAAE;KACd,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,IAAA,kBAAI,EAAC;IAClC,OAAO,EAAE,uBAAe;IACxB,cAAc,EAAE,uBAAe;IAC/B,MAAM,EAAE,IAAA,mBAAK,EAAC,sBAAsB,CAAC;IACrC,sBAAsB,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC5C,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,IAAA,kBAAI,EAAC;IACtC,IAAI,EAAE,iBAAiB;IACvB,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,sBAAsB,CAAC,CAAC;CAChD,CAAC,CAAC;AAEU,QAAA,qBAAqB,GAAG,IAAA,kBAAI,EAAC;IACxC,QAAQ,EAAE,IAAA,mBAAK,EAAC,oBAAoB,CAAC;IACrC,cAAc,EAAE,IAAA,mBAAK,EAAC,0BAA0B,CAAC;CAClD,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,IAAA,kBAAI,EAAC;IACxB,MAAM,EAAE,IAAA,oBAAM,GAAE;IAChB,eAAe,EAAE,IAAA,oBAAM,GAAE;IACzB,QAAQ,EAAE,IAAA,oBAAM,GAAE;IAClB,QAAQ,EAAE,IAAA,qBAAO,GAAE;CACpB,CAAC,CAAC;AAEU,QAAA,6BAA6B,GAAG,IAAA,kBAAI,EAAC;IAChD,OAAO,EAAE,iBAAiB;IAC1B,YAAY,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IACjC,iBAAiB,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IACtC,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACtC,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,YAAY,CAAC,CAAC;IACtC,cAAc,EAAE,IAAA,sBAAQ,EAAC,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC,CAAC;IAC5C,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,wBAAwB,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC9C,CAAC,CAAC;AAEU,QAAA,kCAAkC,GAAG,IAAA,mBAAK,EACrD,qCAA6B,CAC9B,CAAC","sourcesContent":["import {\n  array,\n  boolean,\n  enums,\n  nullable,\n  number,\n  optional,\n  string,\n  type,\n  union,\n} from '@metamask/superstruct';\nimport { StrictHexStruct, CaipAccountIdStruct } from '@metamask/utils';\n\nimport {\n  CANCEL_TYPES,\n  CRYPTO_PAYMENT_METHOD_ERRORS,\n  PAYMENT_TYPES,\n  PRODUCT_TYPES,\n  RECURRING_INTERVALS,\n  SUBSCRIPTION_STATUSES,\n} from './types.js';\n\nconst ProductTypeStruct = enums(Object.values(PRODUCT_TYPES));\nconst PaymentTypeStruct = enums(Object.values(PAYMENT_TYPES));\nconst RecurringIntervalStruct = enums(Object.values(RECURRING_INTERVALS));\nconst SubscriptionStatusStruct = enums(Object.values(SUBSCRIPTION_STATUSES));\nconst CancelTypeStruct = enums(Object.values(CANCEL_TYPES));\nconst CryptoPaymentMethodErrorStruct = enums(\n  Object.values(CRYPTO_PAYMENT_METHOD_ERRORS),\n);\n\nconst ProductStruct = type({\n  name: ProductTypeStruct,\n  currency: enums(['usd']),\n  unitAmount: number(),\n  unitDecimals: number(),\n});\n\nconst SubscriptionCardPaymentMethodStruct = type({\n  type: enums([PAYMENT_TYPES.byCard]),\n  card: type({\n    brand: string(),\n    displayBrand: string(),\n    last4: string(),\n  }),\n});\n\nconst SubscriptionCryptoPaymentMethodStruct = type({\n  type: enums([PAYMENT_TYPES.byCrypto]),\n  crypto: type({\n    payerAddress: StrictHexStruct,\n    chainId: StrictHexStruct,\n    tokenSymbol: string(),\n    error: optional(CryptoPaymentMethodErrorStruct),\n  }),\n});\n\nconst SubscriptionPaymentMethodStruct = union([\n  SubscriptionCardPaymentMethodStruct,\n  SubscriptionCryptoPaymentMethodStruct,\n]);\n\nexport const SubscriptionStruct = type({\n  id: string(),\n  products: array(ProductStruct),\n  currentPeriodStart: string(),\n  currentPeriodEnd: string(),\n  cancelAtPeriodEnd: optional(boolean()),\n  status: SubscriptionStatusStruct,\n  interval: RecurringIntervalStruct,\n  paymentMethod: SubscriptionPaymentMethodStruct,\n  trialPeriodDays: optional(number()),\n  trialStart: optional(string()),\n  trialEnd: optional(string()),\n  endDate: optional(string()),\n  canceledAt: optional(string()),\n  cancelType: CancelTypeStruct,\n  inactiveAt: optional(string()),\n  isEligibleForSupport: boolean(),\n  billingCycles: optional(number()),\n});\n\nexport const GetSubscriptionsResponseStruct = type({\n  customerId: optional(string()),\n  subscriptions: array(SubscriptionStruct),\n  trialedProducts: array(ProductTypeStruct),\n  lastSubscription: optional(SubscriptionStruct),\n  rewardAccountId: optional(CaipAccountIdStruct),\n});\n\nexport const StartSubscriptionResponseStruct = type({\n  checkoutSessionUrl: string(),\n});\n\nexport const StartCryptoSubscriptionResponseStruct = type({\n  subscriptionId: string(),\n  status: SubscriptionStatusStruct,\n});\n\nexport const UpdatePaymentMethodCardResponseStruct = type({\n  redirectUrl: string(),\n});\n\nexport const BillingPortalResponseStruct = type({\n  url: string(),\n});\n\nexport const SubscriptionApiGeneralResponseStruct = type({\n  success: boolean(),\n  message: optional(string()),\n});\n\nconst ProductPriceStruct = type({\n  interval: RecurringIntervalStruct,\n  unitAmount: number(),\n  unitDecimals: number(),\n  currency: enums(['usd']),\n  trialPeriodDays: number(),\n  minBillingCycles: number(),\n  minBillingCyclesForBalance: number(),\n});\n\nconst ProductPricingStruct = type({\n  name: ProductTypeStruct,\n  prices: array(ProductPriceStruct),\n});\n\nconst TokenPaymentInfoStruct = type({\n  symbol: string(),\n  address: StrictHexStruct,\n  decimals: number(),\n  conversionRate: type({\n    usd: string(),\n  }),\n});\n\nconst ChainPaymentInfoStruct = type({\n  chainId: StrictHexStruct,\n  paymentAddress: StrictHexStruct,\n  tokens: array(TokenPaymentInfoStruct),\n  isSponsorshipSupported: optional(boolean()),\n});\n\nconst PricingPaymentMethodStruct = type({\n  type: PaymentTypeStruct,\n  chains: optional(array(ChainPaymentInfoStruct)),\n});\n\nexport const PricingResponseStruct = type({\n  products: array(ProductPricingStruct),\n  paymentMethods: array(PricingPaymentMethodStruct),\n});\n\nconst CohortStruct = type({\n  cohort: string(),\n  eligibilityRate: number(),\n  priority: number(),\n  eligible: boolean(),\n});\n\nexport const SubscriptionEligibilityStruct = type({\n  product: ProductTypeStruct,\n  canSubscribe: optional(boolean()),\n  canViewEntryModal: optional(boolean()),\n  modalType: optional(enums(['A', 'B'])),\n  cohorts: optional(array(CohortStruct)),\n  assignedCohort: optional(nullable(string())),\n  assignedAt: optional(string()),\n  hasAssignedCohortExpired: optional(boolean()),\n});\n\nexport const SubscriptionEligibilityArrayStruct = array(\n  SubscriptionEligibilityStruct,\n);\n"]}