feat(account): add notification email lifecycle events

package.json

@@ -3,7 +3,7 @@
   "description": "Shared Kafka/gRPC contracts and common enums between MonadIAM services",
   "author": "Daniil Egorov (https://github.com/Lambdius)",
   "license": "UNLICENSED",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "exports": {

src/enums.ts

@@ -192,9 +192,12 @@ export enum NotificationTopicAction {
 
 export enum AccountTopicAction {
     /* eslint-disable prettier/prettier */
-    CREATE = "CREATE",
-    VERIFY = "VERIFY",
-    PURGE  = "PURGE",
+    EMAIL_VERIFIED = "EMAIL_VERIFIED",
+    EMAIL_SELECTED = "EMAIL_SELECTED",
+    EMAIL_PURGED   = "EMAIL_PURGED",
+    CREATE         = "CREATE",
+    VERIFY         = "VERIFY",
+    PURGE          = "PURGE",
     /* eslint-enable prettier/prettier */
 }
 

src/kafka/account.schema.json

@@ -8,7 +8,7 @@
   "properties": {
     "actionType": {
       "type": "string",
-      "enum": ["CREATE", "VERIFY", "PURGE"]
+      "enum": ["CREATE", "VERIFY", "PURGE", "EMAIL_VERIFIED", "EMAIL_SELECTED", "EMAIL_PURGED"]
     },
     "payload": {
       "type": "object",
@@ -36,6 +36,9 @@
             }
           }
         },
+        "replacement": {
+          "$ref": "#/properties/payload/properties/identifier"
+        },
         "otp": {
           "type": "string",
           "minLength": 1
@@ -77,6 +80,37 @@
           }
         }
       }
+    },
+    {
+      "if": {
+        "properties": {
+          "actionType": { "enum": ["EMAIL_VERIFIED", "EMAIL_SELECTED", "EMAIL_PURGED"] }
+        }
+      },
+      "then": {
+        "properties": {
+          "payload": {
+            "required": ["account", "identifier"],
+            "properties": {
+              "identifier": { "properties": { "type": { "const": "email" } } },
+              "replacement": { "properties": { "type": { "const": "email" } } }
+            },
+            "not": { "required": ["otp"] }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "actionType": { "not": { "const": "EMAIL_PURGED" } }
+        }
+      },
+      "then": {
+        "properties": {
+          "payload": { "not": { "required": ["replacement"] } }
+        }
+      }
     }
   ]
 }

src/types.ts

@@ -486,7 +486,40 @@ declare global {
                 payload: { account: string };
             };
 
-            type Message = CreateMessage | VerifyMessage | PurgeMessage;
+            type EmailIdentifier = Identifier & { type: "email" };
+
+            type EmailVerifiedMessage = {
+                actionType: AccountTopicAction.EMAIL_VERIFIED;
+                payload: {
+                    identifier: EmailIdentifier;
+                    account: string;
+                };
+            };
+
+            type EmailSelectedMessage = {
+                actionType: AccountTopicAction.EMAIL_SELECTED;
+                payload: {
+                    identifier: EmailIdentifier;
+                    account: string;
+                };
+            };
+
+            type EmailPurgedMessage = {
+                actionType: AccountTopicAction.EMAIL_PURGED;
+                payload: {
+                    replacement?: EmailIdentifier;
+                    identifier: EmailIdentifier;
+                    account: string;
+                };
+            };
+
+            type Message =
+                | EmailVerifiedMessage
+                | EmailSelectedMessage
+                | EmailPurgedMessage
+                | CreateMessage
+                | VerifyMessage
+                | PurgeMessage;
         }
 
         namespace Notification {