feat/HIT-343-Add-triggers-for-email-notifications

src/const/enumTypes.ts

@@ -99,14 +99,17 @@ export const customNotificationStatus = {
 export const customNotificationRecipientsType = {
   email: 'email',
   userField: 'userField',
+  emailField: 'userField',
   distributionList: 'distributionList',
+  channel: 'channel',
 };
 
 /**
  * Enum of custom notification type.
  */
 export const customNotificationType = {
   email: 'email',
+  notification: 'notification',
 };
 
 /**

src/const/placeholders.ts

@@ -5,6 +5,7 @@ export enum Placeholder {
   DATASET = '{{dataset}}',
   NOW = '{{now}}',
   LAST_UPDATE = '{{lastUpdate}}',
+  RECORD_ID = '{{recordId}}',
 }
 
 /** Regex to detect placeholder usage.  */

src/models/customNotification.model.ts

@@ -61,6 +61,11 @@ export const customNotificationSchema = new Schema(
       default: customNotificationLastExecutionStatus.pending,
       required: true,
     },
+    onRecordCreation: Boolean,
+    onRecordUpdate: Boolean,
+    applicationTrigger: Boolean,
+    redirect: mongoose.Schema.Types.Mixed,
+    filter: mongoose.Schema.Types.Mixed,
   },
   {
     timestamps: { createdAt: 'createdAt', updatedAt: 'modifiedAt' },
@@ -72,7 +77,7 @@ export interface CustomNotification extends Document {
   kind: 'CustomNotification';
   name: string;
   description: string;
-  schedule: string;
+  schedule?: string;
   notificationType: string;
   resource: mongoose.Types.ObjectId;
   layout: mongoose.Types.ObjectId;
@@ -84,4 +89,15 @@ export interface CustomNotification extends Document {
   lastExecutionStatus: string;
   createdAt?: Date;
   modifiedAt?: Date;
+  onRecordCreation?: boolean;
+  onRecordUpdate?: boolean; // record deletion counts as an update
+  applicationTrigger?: boolean;
+  filter?: any;
+  redirect?: any;
+  // redirect?: {
+  //   active: boolean;
+  //   type: string; // 'url' | 'recordIds'
+  //   url?: string;
+  //   recordIds?: string[];
+  // };
 }

src/models/notification.model.ts

@@ -9,12 +9,16 @@ const notificationSchema = new Schema(
     channel: {
       type: mongoose.Schema.Types.ObjectId,
       ref: 'Channel',
-      required: true,
     },
     seenBy: {
       type: [mongoose.Schema.Types.ObjectId],
       ref: 'User',
     },
+    user: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'User',
+    },
+    redirect: mongoose.Schema.Types.Mixed,
   },
   {
     timestamps: { createdAt: 'createdAt', updatedAt: 'modifiedAt' },
@@ -34,8 +38,27 @@ export interface Notification extends Document {
   createdAt: Date;
   channel: any;
   seenBy: any[];
+  user?: any;
+  redirect?: any;
+  // redirect?: {
+  //   active: boolean;
+  //   type: string; // 'url' | 'recordIds'
+  //   url?: string;
+  //   recordIds?: string[];
+  //   layout?: string;
+  //   resource?: string;
+  // };
 }
 
+notificationSchema.pre('validate', function (next) {
+  if (!this.channel && !this.user) {
+    return next(
+      new Error('At least only field (channels, user) should be populated')
+    );
+  }
+  next();
+});
+
 notificationSchema.plugin(accessibleRecordsPlugin);
 
 /** Mongoose notification model definition */

src/models/template.model.ts

@@ -17,7 +17,7 @@ export const templateSchema = new Schema(
 /** template documents interface declaration */
 export interface Template extends Document {
   kind: 'Template';
-  type?: 'email'; // In the case we add other types of templates in the future
+  type?: 'email' | 'notification'; // In the case we add other types of templates in the future
   name?: string;
   content?: any;
   createdAt?: Date;

src/schema/inputs/customNotification.input.ts

@@ -3,22 +3,32 @@ import {
   GraphQLNonNull,
   GraphQLString,
   GraphQLID,
+  GraphQLBoolean,
 } from 'graphql';
+import GraphQLJSON from 'graphql-type-json';
 import { Types } from 'mongoose';
 
 /** Custom Notification type for queries/mutations argument */
 export type CustomNotificationArgs = {
   name: string;
   description?: string;
-  schedule: string;
+  schedule?: string;
   notificationType: string;
   resource: string | Types.ObjectId;
   layout: string | Types.ObjectId;
   template: string | Types.ObjectId;
   recipients: string;
   recipientsType: string;
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  notification_status?: string;
+  onRecordCreation?: boolean;
+  onRecordUpdate?: boolean;
+  applicationTrigger?: boolean;
+  status?: string;
+  redirect?: {
+    active: boolean;
+    type: string; // 'url' | 'recordIds'
+    url?: string;
+    recordIds?: string[];
+  };
 };
 
 /** GraphQL custom notification query input type definition */
@@ -28,13 +38,17 @@ export const CustomNotificationInputType = new GraphQLInputObjectType({
   fields: () => ({
     name: { type: new GraphQLNonNull(GraphQLString) },
     description: { type: GraphQLString },
-    schedule: { type: new GraphQLNonNull(GraphQLString) },
+    schedule: { type: GraphQLString },
     notificationType: { type: new GraphQLNonNull(GraphQLString) },
     resource: { type: new GraphQLNonNull(GraphQLID) },
     layout: { type: new GraphQLNonNull(GraphQLID) },
     template: { type: new GraphQLNonNull(GraphQLID) },
     recipients: { type: new GraphQLNonNull(GraphQLString) },
     recipientsType: { type: new GraphQLNonNull(GraphQLString) },
-    // notification_status: { type: new GraphQLNonNull(GraphQLString) },
+    onRecordCreation: { type: GraphQLBoolean },
+    onRecordUpdate: { type: GraphQLBoolean },
+    applicationTrigger: { type: GraphQLBoolean },
+    status: { type: new GraphQLNonNull(GraphQLString) },
+    redirect: { type: GraphQLJSON },
   }),
 });

src/schema/mutation/addCustomNotification.mutation.ts

@@ -65,8 +65,12 @@ export default {
             layout: args.notification.layout,
             template: args.notification.template,
             recipients: args.notification.recipients,
-            status: args.notification.notification_status,
+            status: args.notification.status,
             recipientsType: args.notification.recipientsType,
+            onRecordCreation: args.notification.onRecordCreation,
+            onRecordUpdate: args.notification.onRecordUpdate,
+            applicationTrigger: args.notification.applicationTrigger,
+            redirect: args.notification.redirect,
           },
         },
       };
@@ -78,8 +82,8 @@ export default {
       );
       const notificationDetail = application.customNotifications.pop();
       if (
-        args.notification.notification_status ===
-        customNotificationStatus.active
+        args.notification.schedule &&
+        args.notification.status === customNotificationStatus.active
       ) {
         scheduleCustomNotificationJob(notificationDetail, application);
       }

src/schema/mutation/editCustomNotification.mutation.ts

@@ -16,12 +16,14 @@ import { logger } from '@services/logger.service';
 import { graphQLAuthCheck } from '@schema/shared';
 import { Types } from 'mongoose';
 import { Context } from '@server/apollo/context';
+import GraphQLJSON from 'graphql-type-json';
 
 /** Arguments for the editCustomNotification mutation */
 type EditCustomNotificationArgs = {
   id: string | Types.ObjectId;
   application: string;
-  notification: CustomNotificationArgs;
+  notification?: CustomNotificationArgs;
+  triggersFilters?: any;
 };
 
 /**
@@ -32,7 +34,8 @@ export default {
   args: {
     id: { type: new GraphQLNonNull(GraphQLID) },
     application: { type: new GraphQLNonNull(GraphQLID) },
-    notification: { type: new GraphQLNonNull(CustomNotificationInputType) },
+    notification: { type: CustomNotificationInputType },
+    triggersFilters: { type: GraphQLJSON },
   },
   async resolve(_, args: EditCustomNotificationArgs, context: Context) {
     graphQLAuthCheck(context);
@@ -60,22 +63,38 @@ export default {
         }
       }
       // Save custom notification in application
-      const update = {
-        $set: {
-          'customNotifications.$.name': args.notification.name,
-          'customNotifications.$.description': args.notification.description,
-          'customNotifications.$.schedule': args.notification.schedule,
-          'customNotifications.$.notificationType':
-            args.notification.notificationType,
-          'customNotifications.$.resource': args.notification.resource,
-          'customNotifications.$.layout': args.notification.layout,
-          'customNotifications.$.template': args.notification.template,
-          'customNotifications.$.recipients': args.notification.recipients,
-          'customNotifications.$.status': args.notification.notification_status,
-          'customNotifications.$.recipientsType':
-            args.notification.recipientsType,
-        },
-      };
+      let update = {};
+      if (args.triggersFilters) {
+        update = {
+          $set: {
+            'customNotifications.$.filter': args.triggersFilters,
+          },
+        };
+      } else {
+        update = {
+          $set: {
+            'customNotifications.$.name': args.notification.name,
+            'customNotifications.$.description': args.notification.description,
+            'customNotifications.$.schedule': args.notification.schedule,
+            'customNotifications.$.notificationType':
+              args.notification.notificationType,
+            'customNotifications.$.resource': args.notification.resource,
+            'customNotifications.$.layout': args.notification.layout,
+            'customNotifications.$.template': args.notification.template,
+            'customNotifications.$.recipients': args.notification.recipients,
+            'customNotifications.$.status': args.notification.status,
+            'customNotifications.$.recipientsType':
+              args.notification.recipientsType,
+            'customNotifications.$.onRecordCreation':
+              args.notification.onRecordCreation,
+            'customNotifications.$.onRecordUpdate':
+              args.notification.onRecordUpdate,
+            'customNotifications.$.applicationTrigger':
+              args.notification.applicationTrigger,
+            'customNotifications.$.redirect': args.notification.redirect,
+          },
+        };
+      }
 
       const application = await Application.findOneAndUpdate(
         { _id: args.application, 'customNotifications._id': args.id },
@@ -87,8 +106,10 @@ export default {
         (customNotification) => customNotification.id.toString() === args.id
       );
       if (
-        args.notification.notification_status ===
-        customNotificationStatus.active
+        (args.notification?.schedule &&
+          args.notification?.status === customNotificationStatus.active) ||
+        (args.triggersFilters &&
+          notificationDetail.status === customNotificationStatus.active)
       ) {
         scheduleCustomNotificationJob(notificationDetail, application);
       } else {

src/schema/mutation/editResource.mutation.ts

@@ -852,11 +852,12 @@ export default {
         await updateIncrementalIds(resource, args.idShape);
       }
 
-      return await Resource.findByIdAndUpdate(
+      const updatedResource = await Resource.findByIdAndUpdate(
         args.id,
         update.$addToSet ? { $addToSet: update.$addToSet } : {},
         { new: true }
       );
+      return updatedResource;
     } catch (err) {
       logger.error(err.message, { stack: err.stack });
       if (err instanceof GraphQLError) throw err;

src/schema/mutation/editTemplate.mutation.ts

@@ -44,6 +44,7 @@ export default {
         $set: {
           'templates.$.name': args.template.name,
           'templates.$.content': args.template.content,
+          'templates.$.type': args.template.type,
         },
       };
 

src/schema/query/notifications.query.ts

@@ -54,7 +54,7 @@ export default {
         : {};
 
       let items: any[] = await Notification.find({
-        $and: [cursorFilters, ...filters],
+        $or: [{ $and: [cursorFilters, ...filters] }, { user: context.user }],
       })
         .sort({ createdAt: -1 })
         .limit(first + 1);
@@ -74,7 +74,9 @@ export default {
           endCursor: edges.length > 0 ? edges[edges.length - 1].cursor : null,
         },
         edges,
-        totalCount: await Notification.countDocuments({ $and: filters }),
+        totalCount: await Notification.countDocuments({
+          $or: [{ $and: filters }, { user: context.user }],
+        }),
       };
     } catch (err) {
       logger.error(err.message, { stack: err.stack });

src/schema/types/customNotification.type.ts

@@ -33,6 +33,11 @@ export const CustomNotificationType = new GraphQLObjectType({
     modifiedAt: { type: GraphQLString },
     status: { type: GraphQLString },
     recipientsType: { type: GraphQLString },
+    onRecordCreation: { type: GraphQLBoolean },
+    onRecordUpdate: { type: GraphQLBoolean },
+    applicationTrigger: { type: GraphQLBoolean },
+    filter: { type: GraphQLJSON },
+    redirect: { type: GraphQLJSON },
   }),
 });
 

src/schema/types/notification.type.ts

@@ -42,6 +42,8 @@ export const NotificationType = new GraphQLObjectType({
         return users;
       },
     },
+    user: { type: UserType },
+    redirect: { type: GraphQLJSON },
   }),
 });
 

src/schema/types/record.type.ts

@@ -126,6 +126,14 @@ export const RecordType = new GraphQLObjectType({
         }
       },
     },
+    userCanEdit: {
+      type: GraphQLBoolean,
+      async resolve(parent, args, context) {
+        const parentForm: Form = await Form.findById(parent.form);
+        const ability = await extendAbilityForRecords(context.user, parentForm);
+        return ability.can('update', parent);
+      },
+    },
     validationErrors: {
       type: new GraphQLList(
         new GraphQLObjectType({