🤖 Merge PR DefinitelyTyped#73044 Add ICopilot type and executeEvent and executePrompt by @mikepenaMS

Author: mikepenaMS

types/powerapps-component-framework/componentframework.d.ts

@@ -2834,4 +2834,64 @@ declare namespace ComponentFramework {
             }
         }
     }
+
+    /**
+     * Interface for Copilot functionality
+     */
+    interface Copilot {
+        /**
+         * Executes a Microsoft Copilot Studio Agent's topic based on the registered event name. Returns an array of type MCSResponse.
+         * @param eventName Name of the event to execute
+         * @param parameters Parameters for the event, such as an ID
+         * @returns Promise that resolves with the event result
+         */
+        executeEvent(eventName: string, parameters: Record<string, unknown>): Promise<MCSResponse[]>;
+
+        /**
+         * Executes a Microsoft Copilot Studio Agent's topic based on registered triggered phrases. Returns an array of MCSResponse.
+         * @param promptText The text that is registered as a trigger query in the MCS topic.
+         */
+        executePrompt(promptText: string): Promise<MCSResponse[]>;
+    }
+
+    /**
+     * Interface for Copilot attachment layout types
+     */
+    type AttachmentLayout = "list" | "carousel";
+
+    /**
+     * Interface for Copilot attachments
+     */
+    interface Attachment {
+        content?: unknown;
+        contentType?: string;
+    }
+
+    /**
+     * Interface for Copilot text formats
+     */
+    type TextFormat = "plain" | "markdown" | "xml";
+
+    /*
+     * Interface for Copilot response
+     */
+    interface MCSResponse {
+        type: string;
+        id?: string;
+        locale?: string;
+        replyToId?: string;
+        timestamp?: string;
+        speak?: string;
+        text?: string;
+        textFormat?: TextFormat;
+        suggestedActions?: {
+            actions: unknown[];
+            to?: string[];
+        };
+        value?: unknown;
+        valueType?: string;
+        name?: string;
+        attachmentLayout?: AttachmentLayout;
+        attachments?: Attachment[];
+    }
 }

types/powerapps-component-framework/package.json

@@ -41,10 +41,6 @@
         {
             "name": "Alex Tran",
             "githubUsername": "Alex-MSFT"
-        },
-        {
-            "name": "Michael Pena",
-            "githubUsername": "mikepenaMS"
         }
     ]
 }

types/powerapps-component-framework/powerapps-component-framework-tests.ts

@@ -687,3 +687,38 @@ const entityFormOptionsTest: ComponentFramework.NavigationApi.EntityFormOptions
         entityType: "",
     },
 };
+
+const mcsResponseTest: ComponentFramework.MCSResponse = {
+    type: "message",
+    id: "19e7c095-4b6d-47b5-bc15-1c0ba3d5718d",
+    timestamp: "2025-04-21T20:52:17.9125027+00:00",
+    replyToId: "d0289e39-6192-4197-9fe2-9be66cb5127b",
+    textFormat: "markdown",
+    value: `Hello, here's  **today's weather**`,
+    attachmentLayout: "list",
+    attachments: [
+        {
+            contentType: "application/vnd.microsoft.card.adaptive",
+            content: {
+                type: "AdaptiveCard",
+                $schema: "https://adaptivecards.io/schemas/adaptive-card.json",
+                version: "1.6",
+                body: [
+                    {
+                        type: "TextBlock",
+                        text: "Redmond, WA",
+                        size: "Large",
+                        isSubtle: true,
+                        wrap: true,
+                        style: "heading",
+                    },
+                ],
+            },
+        },
+    ],
+};
+
+const copilotTest: ComponentFramework.Copilot = {
+    executeEvent: (eventName: string, eventData?: any) => Promise.resolve([mcsResponseTest]),
+    executePrompt: (promptText: string) => Promise.resolve([mcsResponseTest]),
+};