feat: create notification to email verification code flow

Giveth · Aug 14, 2024 · be9a06f · be9a06f
1 parent 0a22290
commit be9a06f
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 3 deletions.
diff --git a/migrations/1723578137845-addEmailVerificationCodeFlow.ts b/migrations/1723578137845-addEmailVerificationCodeFlow.ts
@@ -0,0 +1,34 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+import {
+  SCHEMA_VALIDATORS_NAMES,
+  NotificationType,
+} from '../src/entities/notificationType';
+import { NOTIFICATION_CATEGORY } from '../src/types/general';
+import { NOTIFICATIONS_EVENT_NAMES } from '../src/types/notifications';
+import { MICRO_SERVICES } from '../src/utils/utils';
+const EmailConfirmationNotificationCodeFlowType = [
+  {
+    name: NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION_CODE_FLOW,
+    description: NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION_CODE_FLOW,
+    microService: MICRO_SERVICES.givethio,
+    category: NOTIFICATION_CATEGORY.ORTTO,
+    schemaValidator: SCHEMA_VALIDATORS_NAMES.SEND_EMAIL_CONFIRMATION_CODE_FLOW,
+  },
+];
+
+export class AddEmailVerificationCodeFlow1723578137845
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.manager.save(
+      NotificationType,
+      EmailConfirmationNotificationCodeFlowType,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `DELETE FROM notification_type WHERE "name" = 'Send email confirmation code flow';`,
+    );
+  }
+}
diff --git a/src/entities/notificationType.ts b/src/entities/notificationType.ts
@@ -13,6 +13,7 @@ import { NotificationSetting } from './notificationSetting';
 // Export Object with Schemas to N1 lookup
 export const SCHEMA_VALIDATORS_NAMES = {
   SEND_EMAIL_CONFIRMATION: 'sendEmailConfirmation',
+  SEND_EMAIL_CONFIRMATION_CODE_FLOW: 'sendEmailConfirmationCodeFlow',
   CREATE_ORTTO_PROFILE: 'createOrttoProfile',
   SUBSCRIBE_ONBOARDING: 'subscribeOnboarding',
   SUPERFLUID: 'userSuperTokensCritical',

diff --git a/src/services/notificationService.ts b/src/services/notificationService.ts
@@ -37,6 +37,14 @@ export const activityCreator = (
         'str:cm:verificationlink': payload.verificationLink,
       };
       break;
+
+    case NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION_CODE_FLOW:
+      attributes = {
+        'str:cm:email': payload.email,
+        'int:cm:code': payload.verificationCode,
+        'str:cm:userid': payload.userId?.toString(),
+      };
+      break;
     case NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE:
       attributes = {
         'str:cm:email': payload.email,
@@ -202,11 +210,11 @@ export const activityCreator = (
       logger.debug('activityCreator() invalid event name', orttoEventName);
       return;
   }
-  if (!ORTTO_EVENT_NAMES[orttoEventName]) {
+  if (!ORTTO_EVENT_NAMES[orttoEventName as keyof typeof ORTTO_EVENT_NAMES]) {
     logger.debug('activityCreator() invalid ORTTO_EVENT_NAMES', orttoEventName);
     return;
   }
-  const fields = {
+  const fields: Record<string, any> = {
     'str::email': payload.email,
   };
   const merge_by = [];
@@ -223,7 +231,7 @@ export const activityCreator = (
   return {
     activities: [
       {
-        activity_id: `act:cm:${ORTTO_EVENT_NAMES[orttoEventName]}`,
+        activity_id: `act:cm:${ORTTO_EVENT_NAMES[orttoEventName as keyof typeof ORTTO_EVENT_NAMES]}`,
         attributes,
         fields,
       },

diff --git a/src/types/notifications.ts b/src/types/notifications.ts
@@ -50,6 +50,7 @@ export enum NOTIFICATIONS_EVENT_NAMES {
   SUPER_TOKENS_BALANCE_DEPLETED = 'Stream balance depleted',
   CREATE_ORTTO_PROFILE = 'Create Ortto profile',
   SEND_EMAIL_CONFIRMATION = 'Send email confirmation',
+  SEND_EMAIL_CONFIRMATION_CODE_FLOW = 'Send email confirmation code flow',
   SUBSCRIBE_ONBOARDING = 'Subscribe onboarding',
   NOTIFY_REWARD_AMOUNT = 'Notify reward amount',
 }
@@ -79,6 +80,8 @@ export const ORTTO_EVENT_NAMES = {
   [NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE]: 'created-profile',
   [NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION]:
     'verification-form-email-verification',
+  [NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION_CODE_FLOW]:
+    'email-verification-code',
   [NOTIFICATIONS_EVENT_NAMES.NOTIFY_REWARD_AMOUNT]: 'notify-reward',
   [NOTIFICATIONS_EVENT_NAMES.SUBSCRIBE_ONBOARDING]: 'onboarding-form',
 };
diff --git a/src/utils/validators/segmentAndMetadataValidators.ts b/src/utils/validators/segmentAndMetadataValidators.ts
@@ -162,6 +162,12 @@ const sendEmailConfirmationSchema = Joi.object({
   verificationLink: Joi.string().required(),
 });
 
+const sendEmailConfirmationCodeFlowSchema = Joi.object({
+  email: Joi.string().required(),
+  verificationCode: Joi.number().required(),
+  userId: Joi.number().required(),
+});
+
 const notifyRewardAmountSegmentSchema = Joi.object({
   round: Joi.number().required(),
   date: Joi.string().required(),
@@ -185,6 +191,10 @@ export const SEGMENT_METADATA_SCHEMA_VALIDATOR: {
     metadata: null,
     segment: sendEmailConfirmationSchema,
   },
+  sendEmailConfirmationCodeFlow: {
+    metadata: null,
+    segment: sendEmailConfirmationCodeFlowSchema,
+  },
   createOrttoProfile: {
     segment: createOrttoProfileSegmentSchema,
     metadata: null,

diff --git a/src/validators/schemaValidators.ts b/src/validators/schemaValidators.ts
@@ -57,6 +57,7 @@ export const sendNotificationValidator = Joi.object({
       slug: Joi.string(),
       firstName: Joi.string().allow(null).allow(''),
       userId: Joi.number(),
+      verificationCode: Joi.number().allow(null).allow(''),
       projectLink: Joi.string().allow(null).allow(''),
 
       // Email confirmation