Merge pull request #306 from alkem-io/develop

Release: Subspaces

.github/ISSUE_TEMPLATE/bug_report.md

@@ -38,3 +38,6 @@ If applicable, add screenshots to help explain your problem.
 
 **Additional context**
 Add any other context about the problem here.
+
+**Areas that will be affected**
+_Optional, to be added by developer if relevant_

.github/ISSUE_TEMPLATE/user_story.md

@@ -18,3 +18,7 @@ So that <some business value>
 - [ ] …
 
 ## Additional Context
+
+## Areas that will be affected 
+
+_To be added during the refinement_

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "files.eol": "\n"
 }

lib/package.json

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

lib/src/common/enums/journey.type.ts → lib/src/common/enums/space.type.ts

@@ -1,5 +1,5 @@
 // todo: remove once notifications can use the types directly from
-export enum JourneyType {
+export enum SpaceType {
   SPACE = 'space',
   CHALLENGE = 'challenge',
   OPPORTUNITY = 'opportunity',

lib/src/dto/base.event.payload.ts

@@ -1,4 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface BaseEventPayload {
     triggeredBy: string;
+    platform: {
+        url: string;
+    }
 } 

lib/src/dto/collaboration.callout.published.event.payload.ts

@@ -1,11 +1,12 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
-export interface CollaborationCalloutPublishedEventPayload extends JourneyBaseEventPayload {
+export interface CollaborationCalloutPublishedEventPayload extends SpaceBaseEventPayload {
   callout: {
     id: string;
     displayName: string;
     description: string;
     nameID: string;
     type: string;
+    url: string;
   };
 }

lib/src/dto/collaboration.discussion.comment.event.payload.ts

@@ -1,9 +1,10 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
-export interface CollaborationDiscussionCommentEventPayload extends JourneyBaseEventPayload {
+export interface CollaborationDiscussionCommentEventPayload extends SpaceBaseEventPayload {
   callout: {
     displayName: string;
     nameID: string;
+    url: string;
   }
   comment: {
     message: string;

lib/src/dto/collaboration.post.comment.event.payload.ts

@@ -1,14 +1,16 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
-export interface CollaborationPostCommentEventPayload extends JourneyBaseEventPayload {
+export interface CollaborationPostCommentEventPayload extends SpaceBaseEventPayload {
   callout: {
     displayName: string;
     nameID: string;
+    url: string;
   }
   post:  {
     displayName: string;
     createdBy: string;
     nameID: string;
+    url: string;
   };
   comment: {
     message: string;

lib/src/dto/collaboration.post.created.event.payload.ts

@@ -1,15 +1,17 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
-export interface CollaborationPostCreatedEventPayload extends JourneyBaseEventPayload {
+export interface CollaborationPostCreatedEventPayload extends SpaceBaseEventPayload {
   callout: {
     displayName: string;
     nameID: string;
+    url: string;
   }
   post:  {
     id: string;
     createdBy: string;
     displayName: string;
     nameID: string;
     type: string;
+    url: string;
   };
 }

lib/src/dto/collaboration.whiteboard.created.event.payload.ts

@@ -1,14 +1,16 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
-export interface CollaborationWhiteboardCreatedEventPayload extends JourneyBaseEventPayload {
+export interface CollaborationWhiteboardCreatedEventPayload extends SpaceBaseEventPayload {
   callout: {
     displayName: string;
     nameID: string;
+    url: string;
   }
   whiteboard: {
     id: string;
     createdBy: string;
     displayName: string;
     nameID: string;
+    url: string;
   };
 }

lib/src/dto/communication.community.leads.message.payload.ts

@@ -1,6 +1,6 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
 export interface CommunicationCommunityLeadsMessageEventPayload
-    extends JourneyBaseEventPayload {
+    extends SpaceBaseEventPayload {
     message: string;
 }

lib/src/dto/communication.organization.mention.event.payload.ts

@@ -1,11 +1,9 @@
 import { BaseEventPayload } from './base.event.payload';
+import { ContributorPayload } from './contributor.payload';
 export interface CommunicationOrganizationMentionEventPayload
   extends BaseEventPayload {
   comment: string;
-  mentionedOrganization: {
-    id: string;
-    displayName: string;
-  };
+  mentionedOrganization: ContributorPayload;
   commentOrigin: {
     url: string;
     displayName: string;

lib/src/dto/communication.organization.message.event.payload.ts

@@ -1,9 +1,7 @@
 import { BaseEventPayload } from './base.event.payload';
+import { ContributorPayload } from './contributor.payload';
 export interface CommunicationOrganizationMessageEventPayload
   extends BaseEventPayload {
   message: string;
-  organization: {
-    id: string;
-    displayName: string;
-  };
+  organization: ContributorPayload;
 }

lib/src/dto/communication.update.event.payload.ts

@@ -1,9 +1,10 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
-export interface CommunicationUpdateEventPayload extends JourneyBaseEventPayload {
+export interface CommunicationUpdateEventPayload extends SpaceBaseEventPayload {
   update: {
     id: string;
     createdBy: string;
+    url: string;
   };
 
 }

lib/src/dto/communication.user.mention.event.payload.ts

@@ -1,10 +1,8 @@
 import { BaseEventPayload } from './base.event.payload';
+import { ContributorPayload } from './contributor.payload';
 export interface CommunicationUserMentionEventPayload extends BaseEventPayload {
   comment: string;
-  mentionedUser: {
-    id: string;
-    displayName: string;
-  };
+  mentionedUser: ContributorPayload;
   commentOrigin: {
     url: string;
     displayName: string;

lib/src/dto/communication.user.message.event.payload.ts

@@ -1,8 +1,6 @@
 import { BaseEventPayload } from './base.event.payload';
+import { ContributorPayload } from './contributor.payload';
 export interface CommunicationUserMessageEventPayload extends BaseEventPayload {
   message: string;
-  messageReceiver: {
-    id: string;
-    displayName: string;
-  };
+  messageReceiver: ContributorPayload;
 }

lib/src/dto/community.application.created.event.payload.ts

@@ -1,6 +1,7 @@
-import { JourneyPayload } from './journey.payload';
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { SpacePayload } from './space.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
+import { ContributorPayload } from './contributor.payload';
 
-export interface CommunityApplicationCreatedEventPayload extends JourneyBaseEventPayload {
-  applicantID: string;
+export interface CommunityApplicationCreatedEventPayload extends SpaceBaseEventPayload {
+  applicant: ContributorPayload;
 }

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

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

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

@@ -1,6 +1,7 @@
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { ContributorPayload } from './contributor.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
 export interface CommunityInvitationCreatedEventPayload
-  extends JourneyBaseEventPayload {
-  inviteeID: string;
+  extends SpaceBaseEventPayload {
+  invitee: ContributorPayload;
 }

lib/src/dto/community.new.member.payload.ts

@@ -1,6 +1,7 @@
 
-import { JourneyBaseEventPayload } from './journey.base.event.payload';
+import { ContributorPayload } from './contributor.payload';
+import { SpaceBaseEventPayload } from './space.base.event.payload';
 
-export interface CommunityNewMemberPayload extends JourneyBaseEventPayload {
-  userID: string;
+export interface CommunityNewMemberPayload extends SpaceBaseEventPayload {
+  user: ContributorPayload;
 }

lib/src/dto/contributor.payload.ts

@@ -0,0 +1,10 @@
+import { SpaceType } from "@src/common/enums/space.type";
+
+export type ContributorPayload = {
+  id: string;
+  nameID: string;
+  profile: {
+    displayName: string;
+    url: string;
+  }
+};