utm

Author: Dobrunia

src/billing/types/paymentData.ts

@@ -1,3 +1,5 @@
+import type { Utm } from '@hawk.so/types';
+
 /**
  * Data for setting up recurring payments
  */
@@ -83,13 +85,7 @@ export interface PaymentData {
   /**
    * UTM parameters captured when promo was applied
    */
-  promoUtm?: {
-    source?: string;
-    medium?: string;
-    campaign?: string;
-    content?: string;
-    term?: string;
-  };
+  promoUtm?: Utm;
   /**
    * True if this is card linking operation – charging minimal amount of money to validate card info
    */

src/models/user.ts

@@ -7,6 +7,7 @@ import objectHasOnlyProps from '../utils/objectHasOnlyProps';
 import { NotificationsChannelsDBScheme } from '../types/notification-channels';
 import { BankCard, UserDBScheme } from '@hawk.so/types';
 import { v4 as uuid } from 'uuid';
+import type { Utm } from '@hawk.so/types';
 
 /**
  * Utility type for making specific fields optional
@@ -139,7 +140,7 @@ export default class UserModel extends AbstractModel<Omit<UserDBScheme, '_id'>>
   /**
    * UTM parameters from signup - Data form where user went to sign up. Used for analytics purposes
    */
-  public utm?: UserDBScheme['utm'];
+  public utm?: Utm;
 
   /**
    * External identities for SSO (keyed by workspaceId)

src/models/usersFactory.ts

@@ -3,6 +3,7 @@ import UserModel from './user';
 import { Collection, Db, OptionalId } from 'mongodb';
 import DataLoaders from '../dataLoaders';
 import { UserDBScheme } from '@hawk.so/types';
+import type { Utm } from '@hawk.so/types';
 
 /**
  * Users factory to work with User Model
@@ -66,7 +67,7 @@ export default class UsersFactory extends AbstractModelFactory<Omit<UserDBScheme
   public async create(
     email: string,
     password?: string,
-    utm?: UserDBScheme['utm']
+    utm?: Utm
   ): Promise<UserModel> {
     const generatedPassword = password || (await UserModel.generatePassword());
     const hashedPassword = await UserModel.hashPassword(generatedPassword);

src/resolvers/billingNew.ts

@@ -14,6 +14,8 @@ import * as telegram from '../utils/telegram';
 import { TelegramBotURLs } from '../utils/telegram';
 import PromoCodeService, { PromoCodeError, PromoCodeErrorCode, PromoCodePreviewResult } from '../utils/promoCodeService';
 import { publish } from '../rabbitmq';
+import type { Utm } from '@hawk.so/types';
+import { validateUtmParams } from '../utils/utm/utm';
 
 /**
  * The amount we will debit to confirm the subscription.
@@ -30,13 +32,7 @@ interface ComposePaymentArgs {
     tariffPlanId: string;
     shouldSaveCard?: boolean;
     promoCode?: string;
-    promoUtm?: {
-      source?: string;
-      medium?: string;
-      campaign?: string;
-      content?: string;
-      term?: string;
-    };
+    promoUtm?: Utm;
   };
 }
 
@@ -47,13 +43,7 @@ interface PreviewPromoCodeArgs {
   input: {
     workspaceId: string;
     value: string;
-    utm?: {
-      source?: string;
-      medium?: string;
-      campaign?: string;
-      content?: string;
-      term?: string;
-    };
+    utm?: Utm;
   };
 }
 
@@ -132,7 +122,8 @@ export default {
       finalAmount?: number;
       discountAmount?: number;
     }> {
-      const { workspaceId, tariffPlanId, shouldSaveCard, promoCode, promoUtm } = input;
+      const { workspaceId, tariffPlanId, shouldSaveCard, promoCode } = input;
+      const promoUtm = validateUtmParams(input.promoUtm);
 
       if (!workspaceId || !tariffPlanId || !user?.id) {
         throw new UserInputError('No workspaceId, tariffPlanId or user id provided');
@@ -186,7 +177,7 @@ export default {
             originalAmount: pricing.originalAmount,
             finalAmount: pricing.finalAmount,
             discountAmount: pricing.discountAmount,
-            promoUtm,
+            ...(promoUtm && Object.keys(promoUtm).length > 0 ? { promoUtm } : {}),
           };
         } catch (error) {
           throwPromoCodeGraphQLError(error);
@@ -361,7 +352,7 @@ debug: ${Boolean(workspace.isDebug)}`
           };
         }
 
-        await promoCodeService.applyGrantPlan(input.value, user.id, workspace, input.utm);
+        await promoCodeService.applyGrantPlan(input.value, user.id, workspace, validateUtmParams(input.utm));
 
         await publish('cron-tasks', 'cron-tasks/limiter', JSON.stringify({
           type: 'unblock-workspace',

src/resolvers/user.ts

@@ -8,9 +8,9 @@ import { SenderWorkerTaskType } from '../types/userNotifications';
 import { TaskPriorities, emailNotification } from '../utils/emailNotifications';
 import isE2E from '../utils/isE2E';
 import { dateFromObjectId } from '../utils/dates';
-import { UserDBScheme } from '@hawk.so/types';
 import * as telegram from '../utils/telegram';
 import { MongoError } from 'mongodb';
+import type { Utm } from '@hawk.so/types';
 import { validateUtmParams } from '../utils/utm/utm';
 
 /**
@@ -43,7 +43,7 @@ export default {
      */
     async signUp(
       _obj: undefined,
-      { email, utm }: { email: string; utm?: UserDBScheme['utm'] },
+      { email, utm }: { email: string; utm?: Utm },
       { factories }: ResolverContextBase
     ): Promise<boolean | string> {
       const validatedUtm = validateUtmParams(utm);

src/typeDefs/billing.ts

@@ -244,7 +244,7 @@ input ComposePaymentInput {
   """
   UTM parameters captured when promo code was applied
   """
-  promoUtm: PromoCodeUtmInput
+  promoUtm: UtmInput
 }
 
 """
@@ -264,18 +264,7 @@ input PreviewPromoCodeInput {
   """
   UTM parameters captured when promo code was applied
   """
-  utm: PromoCodeUtmInput
-}
-
-"""
-UTM data stored with promo usage
-"""
-input PromoCodeUtmInput {
-  source: String
-  medium: String
-  campaign: String
-  content: String
-  term: String
+  utm: UtmInput
 }
 
 """

src/utils/checksumService.ts

@@ -1,4 +1,5 @@
 import jwt, { Secret } from 'jsonwebtoken';
+import type { Utm } from '@hawk.so/types';
 
 export type ChecksumData = PlanPurchaseChecksumData | CardLinkChecksumData;
 
@@ -50,13 +51,7 @@ interface PlanPurchaseChecksumData {
   /**
    * UTM parameters captured when promo was applied
    */
-  promoUtm?: {
-    source?: string;
-    medium?: string;
-    campaign?: string;
-    content?: string;
-    term?: string;
-  };
+  promoUtm?: Utm;
 }
 
 interface CardLinkChecksumData {

src/utils/promoCodeService.ts

@@ -1,13 +1,13 @@
 import { ObjectId } from 'mongodb';
 import {
   PromoCodeBenefit,
-  PromoCodeBenefitType,
-  PromoCodeUsageDBScheme
+  PromoCodeBenefitType
 } from '@hawk.so/types';
 import PlanModel from '../models/plan';
 import PromoCodeModel from '../models/promoCode';
 import WorkspaceModel from '../models/workspace';
 import { ContextFactories } from '../types/graphql';
+import type { Utm } from '@hawk.so/types';
 
 const PROMO_CODE_REGEXP = /^[A-Z0-9_-]+$/;
 const DEFAULT_MIN_FINAL_PRICE = 1;
@@ -135,7 +135,7 @@ export interface PromoCodePreviewResult {
 /**
  * UTM data stored with promo code usage.
  */
-export type PromoCodeUtm = PromoCodeUsageDBScheme['utm'];
+export type PromoCodeUtm = Utm;
 
 /**
  * Normalizes promo code value before DB lookup.
@@ -475,7 +475,7 @@ export default class PromoCodeService {
         finalAmount: params.finalAmount,
         discountAmount: params.discountAmount,
         appliedAt: new Date(),
-        utm: params.utm,
+        ...(params.utm && Object.keys(params.utm).length > 0 ? { utm: params.utm } : {}),
       });
     } catch (error) {
       if ((error as { code?: number }).code === 11000) {

src/utils/utm/utm.ts

@@ -1,7 +1,18 @@
+import type { Utm } from '@hawk.so/types';
+
 /**
  * Valid UTM parameter keys
  */
-const VALID_UTM_KEYS = ['source', 'medium', 'campaign', 'content', 'term'];
+const VALID_UTM_KEYS = ['source', 'medium', 'campaign', 'content', 'term'] as const;
+
+/**
+ * Checks that passed key is supported UTM field.
+ *
+ * @param key - UTM object key
+ */
+function isValidUtmKey(key: string): key is keyof Utm {
+  return (VALID_UTM_KEYS as readonly string[]).includes(key);
+}
 
 /**
  * Regular expression for valid UTM characters
@@ -19,16 +30,16 @@ const MAX_UTM_VALUE_LENGTH = 50;
  * @param {Object} utm - UTM parameters to validate
  * @returns {Object} - filtered valid UTM parameters
  */
-export function validateUtmParams(utm: any): Record<string, string> | undefined {
+export function validateUtmParams(utm: any): Utm | undefined {
   if (!utm || typeof utm !== 'object' || Array.isArray(utm)) {
     return undefined;
   }
 
-  const result: Record<string, string> = {};
+  const result: Utm = {};
 
   for (const [key, value] of Object.entries(utm)) {
     // 1) Remove keys that are not VALID_UTM_KEYS
-    if (!VALID_UTM_KEYS.includes(key)) {
+    if (!isValidUtmKey(key)) {
       continue;
     }