Added TeamsContent to copilot.sidePanel Interface (#2846)

* adding changefile

* changed tstSelection source

* adding composeType

* added fileURL in the fileContent

* adding teams prefix

* linting

Author: ndangudubiyyam

change/@microsoft-teams-js-d08f708f-cfc9-4ef6-9a54-53c055323e8c.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Added `TeamsContent` interface for `{copilot.sidePanel}` capability.",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

packages/teams-js/src/internal/validOrigins.ts

@@ -165,7 +165,7 @@ function validateOriginWithValidOriginsList(messageOrigin: URL, validOriginsList
 /**
  * @internal
  * Limited to Microsoft-internal use
- * 
+ *
  * This function is only used for testing to reset the valid origins cache and ignore prefetched values.
  */
 export function resetValidOriginsCache(): void {

packages/teams-js/src/private/copilot/sidePanelInterfaces.ts

@@ -13,6 +13,8 @@ export enum ContentItemType {
   CALENDAR_INVITE = 'calendarInvite',
   WEB_PAGE = 'webPage',
   MIXED = 'mixed',
+  TEAMS = 'teams', // Represents Teams-related content, such as chat or channel messages
+  FILE = 'file', // Represents file content, such as documents or attachments
 }
 
 /**
@@ -60,16 +62,9 @@ export interface ServerEmailContent extends BaseEmailContent {
 export interface DraftEmailContent extends BaseEmailContent {
   responseToEmailId?: string; // Optional, if this is a response to another email
   savedTime?: Date;
+  composeType?: 'new' | 'reply' | 'replyAll' | 'forward'; // Type of compose action
 }
 
-/**
- * @hidden
- *
- * Interface for draft email content (no id, times optional)
- *
- * @internal
- * Limited to Microsoft-internal use
- */
 // Union type for usage elsewhere
 export type EmailContent = ServerEmailContent | DraftEmailContent;
 
@@ -94,6 +89,7 @@ export interface CalendarInviteContent {
   attachments?: string[]; // List of attachment file names or URLs
   // Add other calendar event properties
 }
+
 /**
  * @hidden
  *
@@ -122,7 +118,7 @@ export interface WebPageContent {
  */
 export interface TextSelection {
   content: string;
-  source?: EmailContent | WebPageContent | CalendarInviteContent;
+  source?: EmailContent | WebPageContent | CalendarInviteContent | TeamsContent | FileContent;
 }
 
 /**
@@ -203,7 +199,186 @@ export interface MediaSelection {
   type: MediaSelectionType;
   altText?: string;
   content: ImageContent | AudioContent | VideoContent;
-  source?: EmailContent | WebPageContent | CalendarInviteContent;
+  source?: EmailContent | WebPageContent | CalendarInviteContent | TeamsContent | FileContent;
+}
+/**
+ * @hidden
+ *
+ * Interface representing the context of a Microsoft Teams chat.
+ * Contains identifying information for a specific Teams chat session.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface TeamsChatContext {
+  chatId: string; // Unique identifier for the chat
+}
+/**
+ * @hidden
+ *
+ * Interface representing the context of a Microsoft Teams channel.
+ * Contains identifying information for a specific Teams channel and related content.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface TeamsChannelContext {
+  channelId: string; // Unique identifier for the channel
+  teamId: string; // Unique identifier for the team
+  channelName?: string; // Name of the channel
+  postId?: string; // Unique identifier for the post in the channel
+  replyChainId?: string; // Unique identifier for the reply chain in the channel
+  clientConversationId?: string; // Unique identifier for the client conversation
+}
+
+/**
+ * @hidden
+ *
+ * Interface representing the context of a Microsoft Teams meeting.
+ * Contains configuration and identifying information for Teams meeting sessions including Copilot features.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface TeamsMeetingContext {
+  callId: string;
+  threadId: string;
+  organizerId: string;
+  messageId?: string;
+  groupId?: string;
+  sessionType?: TeamsSessionType;
+  vroomId?: string;
+  iCalUid?: string;
+  conversationId?: string;
+  locale?: string;
+  disableHistory?: boolean;
+  Dimensions?: TeamsDimension[];
+  UtteranceInfo?: TeamsUtteranceInfo;
+  copilotMode?: CopilotMode;
+  transcriptState?: TranscriptState;
+  enableMeetingCopilotResponseHandoff?: boolean;
+  enableCopilotResponseCopyRestriction?: boolean;
+  enableMeetingCopilotVisualInsights?: boolean;
+  enableMeetingCopilotCitation?: boolean;
+}
+
+/**
+ * @hidden
+ *
+ * Enum representing different types of Teams session contexts.
+ * Defines the various meeting and chat session types within Microsoft Teams.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+
+export enum TeamsSessionType {
+  Private = 'Private',
+  Shared = 'Shared',
+  Recap = 'Recap',
+  RecapCall = 'RecapCall',
+  PrivateViewCall = 'PrivateViewCall',
+  Chat = 'Chat',
+  Compose = 'Compose',
+}
+/**
+ * @hidden
+ *
+ * Interface for telemetry dimension data used in analytics and reporting.
+ * Contains dimension name-value pairs for categorizing telemetry data.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface TeamsDimension {
+  DimensionName: TeamsDimensionName;
+  DimensionValue: string;
+}
+/**
+ * @hidden
+ *
+ * Enum defining telemetry dimension names for categorizing analytics data.
+ * Used to specify the type of dimension being tracked in telemetry systems.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export enum TeamsDimensionName {
+  ClientDeviceType = 'ClientDeviceType',
+  ClientRing = 'ClientRing',
+  ClientScenarioName = 'ClientScenarioName',
+}
+/**
+ * @hidden
+ *
+ * Interface for utterance identification information used in conversation tracking.
+ * Contains unique identifiers for individual utterances in chat or meeting contexts.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface TeamsUtteranceInfo {
+  utteranceId?: string;
+}
+/**
+ * @hidden
+ *
+ * Enum defining different Copilot operational modes.
+ * Specifies whether Copilot is enabled and how it should function in Teams contexts.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export enum CopilotMode {
+  Enabled = 'enabled',
+  Disabled = 'disabled',
+  EnabledWithTranscript = 'enabledWithTranscript',
+}
+/**
+ * @hidden
+ *
+ * Enum defining different transcript states for meeting recordings.
+ * Indicates the current status of transcript generation and availability.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export enum TranscriptState {
+  NotStarted = 'notStarted',
+  Active = 'active',
+  Inactive = 'inactive',
+  UnknownFutureValue = 'unknownFutureValue',
+}
+/**
+ * @hidden
+ *
+ * Interface for Teams-related content data including app information and context.
+ * Contains metadata about Teams applications and their execution contexts.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface TeamsContent {
+  appName?: string;
+  appVersion?: string;
+  appPlatform?: string;
+  appRingInfo?: string;
+  chatContext?: TeamsChatContext;
+  channelContext?: TeamsChannelContext;
+  meetingContext?: TeamsMeetingContext;
+}
+
+/**
+ * @hidden
+ *
+ * Interface for file content data including URLs and metadata.
+ * Represents file attachments and documents referenced in content.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface FileContent {
+  fileUrl?: string; // URL of the file
 }
 
 /**
@@ -220,6 +395,7 @@ export interface MixedContent {
   media?: (ImageContent | AudioContent | VideoContent)[];
   calendarInvites?: CalendarInviteContent[];
   webPages?: WebPageContent[];
+  files?: FileContent[];
   otherContent?: Array<Record<string, unknown>> | undefined; // Other content types that don't fit into the above categories
 }
 
@@ -237,6 +413,8 @@ export type ContentItem =
   | MediaSelection
   | CalendarInviteContent
   | WebPageContent
+  | TeamsContent
+  | FileContent
   | MixedContent;
 
 /**
@@ -255,6 +433,8 @@ export interface Content {
     | ContentItemType.EMAIL
     | ContentItemType.MEDIA
     | ContentItemType.TEXT
+    | ContentItemType.TEAMS
+    | ContentItemType.FILE
     | ContentItemType.WEB_PAGE
     | ContentItemType.MIXED;
   formCode?: string; // Unique identifier for the content