Merge pull request #232 from alkem-io/develop

Release: External invitations notification

lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alkemio/notifications-lib",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "Library for interacting with Alkemio notifications service",
   "author": "Alkemio Foundation",
   "private": false,

lib/src/dto/community.external.invitation.created.event.payload.ts

@@ -0,0 +1,8 @@
+import { JourneyBaseEventPayload } from './journey.base.event.payload';
+export interface CommunityExternalInvitationCreatedEventPayload
+  extends JourneyBaseEventPayload {
+  invitees: {
+    email: string;
+  }[];
+  welcomeMessage?: string;
+}

lib/src/dto/index.ts

@@ -9,6 +9,7 @@ export * from './communication.organization.mention.event.payload';
 export * from './community.application.created.event.payload';
 export * from './community.new.member.payload';
 export * from './community.invitation.created.event.payload';
+export * from './community.external.invitation.created.event.payload';
 export * from './collaboration.interest.payload';
 export * from './collaboration.whiteboard.created.event.payload';
 export * from './collaboration.post.created.event.payload';

lib/src/notification.event.type.ts

@@ -2,6 +2,7 @@ export enum NotificationEventType {
   COMMUNITY_APPLICATION_CREATED = 'communityApplicationCreated',
   COMMUNITY_NEW_MEMBER = 'communityNewMember',
   COMMUNITY_INVITATION_CREATED = 'communityInvitationCreated',
+  COMMUNITY_EXTERNAL_INVITATION_CREATED = 'communityExternalInvitationCreated',
   COMMUNICATION_COMMENT_SENT = 'communicationCommentSent',
   COMMUNICATION_UPDATE_SENT = 'communicationUpdateSent',
   COMMUNICATION_USER_MESSAGE = 'communicationUserMessage',

service/notifications.yml

@@ -83,7 +83,7 @@ alkemio:
     password: ${SERVICE_ACCOUNT_PASSWORD}:change-me-now
 
 kratos:
-  public_endpoint: ${KRATOS_API_PUBLIC_ENDPOINT}:http://localhost:3000/identity/ory/kratos/public
+  public_endpoint: ${KRATOS_API_PUBLIC_ENDPOINT}:http://localhost:3000/ory/kratos/public
 
 recipients:
   community_application_created:
@@ -132,6 +132,17 @@ recipients:
         - rule:
             type: USER_SELF_MANAGEMENT
             resource_id: <inviteeID>
+  community_external_invitation_created:
+    - name: inviter
+      rules:
+        - rule:
+            type: USER_SELF_MANAGEMENT
+            resource_id: <inviterID>
+    - name: invitee
+      rules:
+        - rule:
+            type: EXTERNAL_USER
+            resource_id:
   communication_update_sent:
     - name: admin
       rules:

service/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alkemio-notifications",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Alkemio notifications service",
   "author": "Alkemio Foundation",
   "private": false,
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "@alkemio/client-lib": "^0.21.0",
-    "@alkemio/notifications-lib": "^0.5.3",
+    "@alkemio/notifications-lib": "^0.6.0",
     "@nestjs/common": "^8.0.5",
     "@nestjs/config": "^1.0.1",
     "@nestjs/core": "^8.0.5",

service/src/app.controller.ts

@@ -37,6 +37,7 @@ import {
 } from '@alkemio/notifications-lib';
 import { NotificationService } from './services/domain/notification/notification.service';
 import { ALKEMIO_CLIENT_ADAPTER, LogContext } from './common/enums';
+import { CommunityExternalInvitationCreatedEventPayload } from '@alkemio/notifications-lib';
 
 @Controller()
 export class AppController {
@@ -78,6 +79,22 @@ export class AppController {
     );
   }
 
+  @EventPattern(NotificationEventType.COMMUNITY_EXTERNAL_INVITATION_CREATED)
+  async sendExternalInvitationNotification(
+    // todo is auto validation possible
+    @Payload() eventPayload: CommunityExternalInvitationCreatedEventPayload,
+    @Ctx() context: RmqContext
+  ) {
+    this.sendNotifications(
+      eventPayload,
+      context,
+      this.notificationService.sendExternalInvitationCreatedNotifications(
+        eventPayload
+      ),
+      NotificationEventType.COMMUNITY_EXTERNAL_INVITATION_CREATED
+    );
+  }
+
   @EventPattern(NotificationEventType.COMMUNITY_NEW_MEMBER)
   async sendCommunityNewMemberNotification(
     // todo is auto validation possible

service/src/app.module.ts

@@ -39,6 +39,7 @@ import { CollaborationWhiteboardCreatedNotificationBuilder } from './services/do
 import { CollaborationDiscussionCommentNotificationBuilder } from './services/domain/builders/collaboration-discussion-comment/collaboration.discussion.comment.notification.builder';
 import { CommunityInvitationCreatedNotificationBuilder } from './services/domain/builders/community-invitation-created/community.invitation.created.notification.builder';
 import { CommentReplyNotificationBuilder } from './services/domain/builders/comment-reply/comment.reply.notification.builder';
+import { CommunityExternalInvitationCreatedNotificationBuilder } from './services/domain/builders/community-external-invitation-created/community.external.invitation.created.notification.builder';
 
 @Module({
   imports: [
@@ -64,6 +65,7 @@ import { CommentReplyNotificationBuilder } from './services/domain/builders/comm
     NotificationBuilder,
     CommunityApplicationCreatedNotificationBuilder,
     CommunityInvitationCreatedNotificationBuilder,
+    CommunityExternalInvitationCreatedNotificationBuilder,
     PlatformUserRegisteredNotificationBuilder,
     PlatformUserRemovedNotificationBuilder,
     PlatformForumDiscussionCommentNotificationBuilder,

service/src/common/email-template-payload/communication.user.mention.email.payload.ts

@@ -6,10 +6,6 @@ export interface CommunicationUserMentionEmailPayload extends BaseEmailPayload {
     firstName: string;
   };
   comment: string;
-  mentionedUser: {
-    displayName: string;
-    firstName: string;
-  };
   commentOrigin: {
     url: string;
     displayName: string;

service/src/common/email-template-payload/community.external.invitation.created.email.payload.ts

@@ -0,0 +1,14 @@
+import { BaseJourneyEmailPayload } from './base.journey.email.payload';
+
+export interface CommunityExternalInvitationCreatedEmailPayload
+  extends BaseJourneyEmailPayload {
+  inviter: {
+    name: string;
+    firstName: string;
+    email: string;
+    profile: string;
+  };
+  welcomeMessage?: string;
+  emails?: string;
+  journeyAdminURL: string;
+}

service/src/common/email-template-payload/index.ts

@@ -2,6 +2,7 @@ export * from './base.email.payload';
 export * from './base.journey.email.payload';
 export * from './community.application.created.email.payload';
 export * from './community.invitation.created.email.payload';
+export * from './community.external.invitation.created.email.payload';
 export * from './community.new.member.email.payload';
 export * from './collaboration.whiteboard.created.email.payload';
 export * from './collaboration.post.comment.email.payload';

service/src/common/enums/email.template.ts

@@ -6,6 +6,8 @@ export enum EmailTemplate {
   COMMUNITY_INVITATION_ADMIN = 'community.invitation.created.admin',
   COMMUNITY_INVITATION_INVITEE = 'community.invitation.created.invitee',
   COMMUNITY_INVITATION_INVITER = 'community.invitation.created.inviter',
+  COMMUNITY_EXTERNAL_INVITATION_INVITEE = 'community.external.invitation.created.invitee',
+  COMMUNITY_EXTERNAL_INVITATION_INVITER = 'community.external.invitation.created.inviter',
   COMMUNICATION_UPDATE_ADMIN = 'communication.update.admin',
   COMMUNICATION_UPDATE_MEMBER = 'communication.update.member',
   COMMUNICATION_USER_MESSAGE_SENDER = 'communication.user.message.sender',

service/src/core/contracts/notification.recipient.template.provider.interface.ts

@@ -16,6 +16,7 @@ export type TemplateRuleSet = {
 export type TemplateConfig = {
   community_application_created?: TemplateRuleSet[];
   community_invitation_created?: TemplateRuleSet[];
+  community_external_invitation_created?: TemplateRuleSet[];
   community_new_member?: TemplateRuleSet[];
   communication_update_sent?: TemplateRuleSet[];
   platform_forum_discussion_created?: TemplateRuleSet[];

service/src/core/models/credential.criterion.ts

@@ -1,5 +1,7 @@
 import { AuthorizationCredential } from '@alkemio/client-lib';
 
+export const ROLE_EXTERNAL_USER = 'EXTERNAL_USER';
+
 export type CredentialCriterion = {
   type: AuthorizationCredential;
   resourceID?: string;

service/src/core/models/user.ts

@@ -11,6 +11,29 @@ export type User = {
   };
 };
 
+export type InternalUser = {
+  id: string;
+  nameID: string;
+  firstName: string;
+  lastName: string;
+  email: string;
+  preferences?: UserPreference[];
+  profile: {
+    id: string;
+    displayName: string;
+  };
+};
+
+export type ExternalUser = {
+  firstName: string;
+  lastName: string;
+  email: string;
+};
+
+export const isUser = (user: User | ExternalUser): user is User => {
+  return (user as User).nameID !== undefined;
+};
+
 export type UserPreference = {
   definition: UserPreferenceDefinition;
   value: string;

service/src/services/application/alkemio-url-generator/alkemio.url.generator.ts

@@ -13,6 +13,7 @@ import {
   createOrganizationURL as libCreateOrganizationURL,
   createUserNotificationPreferencesURL as libCreateUserNotificationPreferencesURL,
 } from '@alkemio/notifications-lib';
+import { ExternalUser, User, isUser } from '@src/core/models';
 
 @Injectable()
 export class AlkemioUrlGenerator {
@@ -67,10 +68,12 @@ export class AlkemioUrlGenerator {
     return libCreateOrganizationURL(this.webclientEndpoint, orgNameID);
   }
 
-  createUserNotificationPreferencesURL(userNameID: string): string {
-    return libCreateUserNotificationPreferencesURL(
-      this.webclientEndpoint,
-      userNameID
-    );
+  createUserNotificationPreferencesURL(user: User | ExternalUser): string {
+    return isUser(user)
+      ? libCreateUserNotificationPreferencesURL(
+          this.webclientEndpoint,
+          user.nameID
+        )
+      : '';
   }
 }