feat(billing): introduce PaymentPromoBenefitType and update promo data structure

Author: Dobrunia

src/billing/types/paymentData.ts

@@ -1,4 +1,9 @@
-import type { Utm } from '@hawk.so/types';
+import type { PromoCodeBenefitType, Utm } from '@hawk.so/types';
+
+/**
+ * Promo benefit types that can be applied during payment.
+ */
+export type PaymentPromoBenefitType = Exclude<PromoCodeBenefitType, 'grant_plan'>;
 
 /**
  * Data for setting up recurring payments
@@ -49,7 +54,7 @@ export interface PaymentPromoData {
   /**
    * Promo benefit type
    */
-  benefitType: 'percent_discount' | 'amount_discount' | 'fixed_price';
+  benefitType: PaymentPromoBenefitType;
 
   /**
    * Plan price before promo

src/resolvers/billingNew.ts

@@ -14,6 +14,7 @@ import * as telegram from '../utils/telegram';
 import { TelegramBotURLs } from '../utils/telegram';
 import PromoCodeService, { PromoCodeError, PromoCodeErrorCode, PromoCodePreviewResult, buildPaymentPromoData } from '../utils/promoCodeService';
 import { publish } from '../rabbitmq';
+import type { PaymentPromoData } from '../billing/types/paymentData';
 import type { Utm } from '@hawk.so/types';
 import { validateUtmParams } from '../utils/utm/utm';
 
@@ -117,13 +118,7 @@ export default {
       checksum: string;
       nextPaymentDate: Date;
       cloudPaymentsPublicId: string;
-      promo?: {
-        id: string;
-        benefitType: 'percent_discount' | 'amount_discount' | 'fixed_price';
-        originalAmount: number;
-        finalAmount: number;
-        discountAmount: number;
-      };
+      promo?: PaymentPromoData;
     }> {
       const { workspaceId, tariffPlanId, shouldSaveCard, promoCode } = input;
       const promoUtm = validateUtmParams(input.promoUtm);

src/utils/promoCodeService.ts

@@ -8,7 +8,7 @@ import PromoCodeModel from '../models/promoCode';
 import WorkspaceModel from '../models/workspace';
 import { ContextFactories } from '../types/graphql';
 import type { Utm } from '@hawk.so/types';
-import type { PaymentPromoData } from '../billing/types/paymentData';
+import type { PaymentPromoData, PaymentPromoBenefitType } from '../billing/types/paymentData';
 
 const PROMO_CODE_REGEXP = /^[A-Z0-9_-]+$/;
 const DEFAULT_MIN_FINAL_PRICE = 1;
@@ -342,7 +342,7 @@ function validateBenefitStructure(benefit: PromoCodeBenefit): void {
 export function buildPaymentPromoData(pricing: PromoCodePricingResult, utm?: Utm): PaymentPromoData {
   return {
     id: pricing.promoCode._id.toString(),
-    benefitType: pricing.benefitType as PaymentPromoData['benefitType'],
+    benefitType: pricing.benefitType as PaymentPromoBenefitType,
     originalAmount: pricing.originalAmount,
     finalAmount: pricing.finalAmount,
     discountAmount: pricing.discountAmount,