Api/Apps: break App class and IActivityContext up

packages/api/src/activities/activity.spec.ts

@@ -20,7 +20,7 @@ describe('Activity', () => {
   };
 
   it('should build', () => {
-    const activity = new Activity({ type: 'example' })
+    const activity = new Activity({ type: 'test' })
       .withId('1')
       .withLocale('en')
       .withFrom(user)
@@ -33,10 +33,12 @@ describe('Activity', () => {
       })
       .withRecipient(bot)
       .withReplyToId('3')
-      .addAiGenerated()
-      .addFeedback();
+      .withServiceUrl('http://localhost')
+      .withTimestamp(new Date())
+      .withLocalTimestamp(new Date());
 
     expect(activity.id).toEqual('1');
+    expect(activity.type).toEqual('test');
     expect(activity.locale).toEqual('en');
     expect(activity.from).toStrictEqual(user);
     expect(activity.conversation).toStrictEqual(chat);
@@ -49,15 +51,150 @@ describe('Activity', () => {
 
     expect(activity.recipient).toEqual(bot);
     expect(activity.replyToId).toEqual('3');
-    expect(activity.entities).toStrictEqual([
-      {
-        type: 'https://schema.org/Message',
-        '@type': 'Message',
-        '@context': 'https://schema.org',
-        additionalType: ['AIGeneratedContent'],
-      },
-    ]);
-
-    expect(activity.channelData?.feedbackLoopEnabled).toEqual(true);
+    expect(activity.serviceUrl).toEqual('http://localhost');
+    expect(activity.timestamp).toBeDefined();
+    expect(activity.localTimestamp).toBeDefined();
+  });
+
+  it('should build from interface', () => {
+    const activity = Activity.from(
+      new Activity({ type: 'test' })
+        .withId('1')
+        .withLocale('en')
+        .withFrom(user)
+        .withConversation(chat)
+        .withRecipient(bot)
+        .toInterface()
+    );
+
+    expect(activity.id).toEqual('1');
+    expect(activity.type).toEqual('test');
+    expect(activity.locale).toEqual('en');
+    expect(activity.from).toEqual(user);
+    expect(activity.conversation).toEqual(chat);
+    expect(activity.recipient).toEqual(bot);
+  });
+
+  it('should clone', () => {
+    const activity = Activity.from(
+      new Activity({ type: 'test' })
+        .withId('1')
+        .withLocale('en')
+        .withFrom(user)
+        .withConversation(chat)
+        .withRecipient(bot)
+        .toInterface()
+    ).clone();
+
+    expect(activity.id).toEqual('1');
+    expect(activity.type).toEqual('test');
+    expect(activity.locale).toEqual('en');
+    expect(activity.from).toEqual(user);
+    expect(activity.conversation).toEqual(chat);
+    expect(activity.recipient).toEqual(bot);
+  });
+
+  it('should have channel data accessors', () => {
+    const activity = new Activity({ type: 'test' })
+      .withId('1')
+      .withLocale('en')
+      .withFrom(user)
+      .withConversation(chat)
+      .withRecipient(bot)
+      .withChannelData({
+        tenant: { id: 'tenant-id' },
+        channel: { id: 'channel-id' },
+        team: { id: 'team-id' },
+        meeting: { id: 'meeting-id' },
+        notification: { alert: true },
+      });
+
+    expect(activity.id).toEqual('1');
+    expect(activity.type).toEqual('test');
+    expect(activity.locale).toEqual('en');
+    expect(activity.from).toEqual(user);
+    expect(activity.conversation).toEqual(chat);
+    expect(activity.recipient).toEqual(bot);
+    expect(activity.tenant?.id).toEqual('tenant-id');
+    expect(activity.channel?.id).toEqual('channel-id');
+    expect(activity.team?.id).toEqual('team-id');
+    expect(activity.meeting?.id).toEqual('meeting-id');
+    expect(activity.notification?.alert).toEqual(true);
+  });
+
+  describe('addAiGenerated', () => {
+    it('should add', () => {
+      const activity = new Activity({ type: 'test' }).addAiGenerated();
+
+      expect(activity.type).toEqual('test');
+      expect(activity.entities).toStrictEqual([
+        {
+          type: 'https://schema.org/Message',
+          '@type': 'Message',
+          '@context': 'https://schema.org',
+          additionalType: ['AIGeneratedContent'],
+        },
+      ]);
+    });
+  });
+
+  describe('addFeedback', () => {
+    it('should add', () => {
+      const activity = new Activity({ type: 'test' }).addFeedback();
+
+      expect(activity.type).toEqual('test');
+      expect(activity.channelData?.feedbackLoopEnabled).toEqual(true);
+    });
+  });
+
+  describe('addCitation', () => {
+    it('should add', () => {
+      const activity = new Activity({ type: 'test' }).addCitation(0, {
+        abstract: 'test',
+        name: 'test',
+      });
+
+      expect(activity.type).toEqual('test');
+      expect(activity.entities).toEqual([
+        {
+          type: 'https://schema.org/Message',
+          '@type': 'Claim',
+          position: 0,
+          appearance: {
+            '@type': 'DigitalDocument',
+            abstract: 'test',
+            name: 'test',
+            encodingFormat: 'application/vnd.microsoft.card.adaptive',
+          },
+        },
+      ]);
+    });
+
+    it('should add with icon', () => {
+      const activity = new Activity({ type: 'test' }).addCitation(0, {
+        abstract: 'test',
+        name: 'test',
+        icon: 'GIF',
+      });
+
+      expect(activity.type).toEqual('test');
+      expect(activity.entities).toEqual([
+        {
+          type: 'https://schema.org/Message',
+          '@type': 'Claim',
+          position: 0,
+          appearance: {
+            '@type': 'DigitalDocument',
+            abstract: 'test',
+            name: 'test',
+            encodingFormat: 'application/vnd.microsoft.card.adaptive',
+            image: {
+              '@type': 'ImageObject',
+              name: 'GIF',
+            },
+          },
+        },
+      ]);
+    });
   });
 });

packages/api/src/activities/activity.ts

@@ -2,10 +2,14 @@ import {
   Account,
   ChannelData,
   ChannelID,
+  ChannelInfo,
   CitationAppearance,
   ConversationAccount,
   ConversationReference,
   Entity,
+  MeetingInfo,
+  NotificationInfo,
+  TeamInfo,
 } from '../models';
 
 export interface IActivity<T extends string = string> {
@@ -84,6 +88,26 @@ export interface IActivity<T extends string = string> {
    * Contains channel-specific content.
    */
   channelData?: ChannelData;
+
+  /**
+   * Information about the channel in which the message was sent.
+   */
+  get channel(): ChannelInfo | undefined;
+
+  /**
+   * Information about the team in which the message was sent.
+   */
+  get team(): TeamInfo | undefined;
+
+  /**
+   * Information about the tenant in which the message was sent.
+   */
+  get meeting(): MeetingInfo | undefined;
+
+  /**
+   * Notification settings for the message.
+   */
+  get notification(): NotificationInfo | undefined;
 }
 
 export class Activity<T extends string = string> implements IActivity<T> {
@@ -163,8 +187,61 @@ export class Activity<T extends string = string> implements IActivity<T> {
    */
   channelData?: ChannelData;
 
+  /**
+   * Information about the tenant in which the message was sent.
+   */
+  get tenant() {
+    return this.channelData?.tenant;
+  }
+
+  /**
+   * Information about the channel in which the message was sent.
+   */
+  get channel() {
+    return this.channelData?.channel;
+  }
+
+  /**
+   * Information about the team in which the message was sent.
+   */
+  get team() {
+    return this.channelData?.team;
+  }
+
+  /**
+   * Information about the tenant in which the message was sent.
+   */
+  get meeting() {
+    return this.channelData?.meeting;
+  }
+
+  /**
+   * Notification settings for the message.
+   */
+  get notification() {
+    return this.channelData?.notification;
+  }
+
   constructor(value: Pick<IActivity<T>, 'type'> & Partial<Omit<IActivity<T>, 'type'>>) {
-    Object.assign(this, value);
+    Object.assign(this, {
+      channelId: 'msteams',
+      ...value,
+    });
+  }
+
+  static from(activity: IActivity) {
+    return new Activity(activity);
+  }
+
+  toInterface(): IActivity {
+    return Object.assign({}, this);
+  }
+
+  clone(options: Omit<Partial<IActivity>, 'type'> = {}) {
+    return new Activity({
+      ...this.toInterface(),
+      ...options,
+    });
   }
 
   withId(value: string) {