@microsoft/agents-hosting-extensions-msteams 1.7.2

package/dist/src/messages/message.d.ts

@@ -0,0 +1,67 @@
+import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
+import type { O365ConnectorCardActionQuery } from '@microsoft/teams.api';
+import { TeamsTurnContext } from '../teamsTurnContext';
+import type { ReadReceiptInfo } from '../models/readReceiptInfo';
+import { TeamsRouteHandler } from '../teamsRouteHandler';
+type ExecuteActionRouteHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, query: O365ConnectorCardActionQuery) => Promise<void>;
+type ReadReceiptHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, data: ReadReceiptInfo) => Promise<void>;
+/**
+ * Registers handlers for Microsoft Teams message lifecycle events.
+ *
+ * @typeParam TState - The turn state type used by the agent application.
+ */
+export declare class Message<TState extends TurnState = TurnState> {
+    private _app;
+    /**
+     * Creates a Teams message route helper.
+     *
+     * @param app - The agent application that receives the registered routes.
+     */
+    constructor(app: AgentApplication<TState>);
+    /**
+     * Registers a handler for Teams message edit events.
+     *
+     * @param handler - Handler invoked for matching message edit activities.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onMessageEdit(handler: TeamsRouteHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams soft-delete message events.
+     *
+     * @param handler - Handler invoked for matching message delete activities.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onMessageDelete(handler: TeamsRouteHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams message undelete events.
+     *
+     * @param handler - Handler invoked for matching message update activities.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onMessageUndelete(handler: TeamsRouteHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams read receipt events.
+     *
+     * @param handler - Handler invoked with read receipt information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onReadReceipt(handler: ReadReceiptHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Office 365 connector card execute action invokes.
+     *
+     * @param handler - Handler invoked with the connector card action query.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onExecuteAction(handler: ExecuteActionRouteHandler<TState>, rank?: number, authHandlers?: string[]): this;
+}
+export {};

package/dist/src/messages/message.js

@@ -0,0 +1,129 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Message = void 0;
+const agents_activity_1 = require("@microsoft/agents-activity");
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const activity_extensions_1 = require("../activity-extensions");
+const teamsTurnContext_1 = require("../teamsTurnContext");
+const teamsRouteHandler_1 = require("../teamsRouteHandler");
+function equalsIgnoreCase(actual, expected) {
+    return typeof actual === 'string' && actual.toLowerCase() === expected.toLowerCase();
+}
+/**
+ * Registers handlers for Microsoft Teams message lifecycle events.
+ *
+ * @typeParam TState - The turn state type used by the agent application.
+ */
+class Message {
+    /**
+     * Creates a Teams message route helper.
+     *
+     * @param app - The agent application that receives the registered routes.
+     */
+    constructor(app) {
+        this._app = app;
+    }
+    /**
+     * Registers a handler for Teams message edit events.
+     *
+     * @param handler - Handler invoked for matching message edit activities.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onMessageEdit(handler, rank = agents_hosting_1.RouteRank.Unspecified, authHandlers = []) {
+        const routeSel = (context) => {
+            const channelData = (0, activity_extensions_1.parseTeamsChannelData)(context.activity.channelData);
+            return Promise.resolve(context.activity.type === agents_activity_1.ActivityTypes.MessageUpdate &&
+                context.activity.channelId === 'msteams' &&
+                equalsIgnoreCase(channelData === null || channelData === void 0 ? void 0 : channelData.eventType, 'editMessage'));
+        };
+        this._app.addRoute(routeSel, (0, teamsRouteHandler_1.createTeamsRouteHandler)(handler), false, rank, authHandlers);
+        return this;
+    }
+    /**
+     * Registers a handler for Teams soft-delete message events.
+     *
+     * @param handler - Handler invoked for matching message delete activities.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onMessageDelete(handler, rank = agents_hosting_1.RouteRank.Unspecified, authHandlers = []) {
+        const routeSel = (context) => {
+            const channelData = (0, activity_extensions_1.parseTeamsChannelData)(context.activity.channelData);
+            return Promise.resolve(context.activity.type === agents_activity_1.ActivityTypes.MessageDelete &&
+                context.activity.channelId === 'msteams' &&
+                equalsIgnoreCase(channelData === null || channelData === void 0 ? void 0 : channelData.eventType, 'softDeleteMessage'));
+        };
+        this._app.addRoute(routeSel, (0, teamsRouteHandler_1.createTeamsRouteHandler)(handler), false, rank, authHandlers);
+        return this;
+    }
+    /**
+     * Registers a handler for Teams message undelete events.
+     *
+     * @param handler - Handler invoked for matching message update activities.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onMessageUndelete(handler, rank = agents_hosting_1.RouteRank.Unspecified, authHandlers = []) {
+        const routeSel = (context) => {
+            const channelData = (0, activity_extensions_1.parseTeamsChannelData)(context.activity.channelData);
+            return Promise.resolve(context.activity.type === agents_activity_1.ActivityTypes.MessageUpdate &&
+                context.activity.channelId === 'msteams' &&
+                equalsIgnoreCase(channelData === null || channelData === void 0 ? void 0 : channelData.eventType, 'undeleteMessage'));
+        };
+        this._app.addRoute(routeSel, (0, teamsRouteHandler_1.createTeamsRouteHandler)(handler), false, rank, authHandlers);
+        return this;
+    }
+    /**
+     * Registers a handler for Teams read receipt events.
+     *
+     * @param handler - Handler invoked with read receipt information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onReadReceipt(handler, rank = agents_hosting_1.RouteRank.Unspecified, authHandlers = []) {
+        const routeSel = (context) => {
+            return Promise.resolve(context.activity.type === agents_activity_1.ActivityTypes.Event &&
+                context.activity.channelId === 'msteams' &&
+                equalsIgnoreCase(context.activity.name, 'application/vnd.microsoft.readReceipt'));
+        };
+        const routeHandler = async (context, state) => {
+            await handler(new teamsTurnContext_1.TeamsTurnContext(context), state, context.activity.value);
+        };
+        this._app.addRoute(routeSel, routeHandler, false, rank, authHandlers);
+        return this;
+    }
+    /**
+     * Registers a handler for Office 365 connector card execute action invokes.
+     *
+     * @param handler - Handler invoked with the connector card action query.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This message helper for chaining.
+     */
+    onExecuteAction(handler, rank = agents_hosting_1.RouteRank.Unspecified, authHandlers = []) {
+        const routeSel = (context) => {
+            return Promise.resolve(context.activity.type === agents_activity_1.ActivityTypes.Invoke &&
+                context.activity.channelId === 'msteams' &&
+                equalsIgnoreCase(context.activity.name, 'actionableMessage/executeAction'));
+        };
+        const routeHandler = async (context, state) => {
+            var _a;
+            const query = ((_a = context.activity.value) !== null && _a !== void 0 ? _a : {});
+            await handler(new teamsTurnContext_1.TeamsTurnContext(context), state, query);
+            const invokeResponse = new agents_activity_1.Activity(agents_activity_1.ActivityTypes.InvokeResponse);
+            invokeResponse.value = { status: 200 };
+            await context.sendActivity(invokeResponse);
+        };
+        this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers);
+        return this;
+    }
+}
+exports.Message = Message;
+//# sourceMappingURL=message.js.map

package/dist/src/messages/message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../../../src/messages/message.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAC5D,kCAAkC;;;AAElC,gEAAoE;AACpE,8DAA4H;AAC5H,gEAA8D;AAE9D,0DAAsD;AAEtD,4DAAiF;AAKjF,SAAS,gBAAgB,CAAE,MAAe,EAAE,QAAgB;IAC1D,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CAAA;AACtF,CAAC;AAED;;;;GAIG;AACH,MAAa,OAAO;IAGlB;;;;OAIG;IACH,YAAa,GAA6B;QACxC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;IACjB,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAE,OAAkC,EAAE,OAAe,0BAAS,CAAC,WAAW,EAAE,eAAyB,EAAE;QAClH,MAAM,QAAQ,GAAkB,CAAC,OAAoB,EAAE,EAAE;YACvD,MAAM,WAAW,GAAG,IAAA,2CAAqB,EAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;YACvE,OAAO,OAAO,CAAC,OAAO,CACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,aAAa;gBACrD,OAAO,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;gBACxC,gBAAgB,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,EAAE,aAAa,CAAC,CACxD,CAAA;QACH,CAAC,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAA,2CAAuB,EAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QACzF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAE,OAAkC,EAAE,OAAe,0BAAS,CAAC,WAAW,EAAE,eAAyB,EAAE;QACpH,MAAM,QAAQ,GAAkB,CAAC,OAAoB,EAAE,EAAE;YACvD,MAAM,WAAW,GAAG,IAAA,2CAAqB,EAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;YACvE,OAAO,OAAO,CAAC,OAAO,CACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,aAAa;gBACrD,OAAO,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;gBACxC,gBAAgB,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,EAAE,mBAAmB,CAAC,CAC9D,CAAA;QACH,CAAC,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAA,2CAAuB,EAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QACzF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,iBAAiB,CAAE,OAAkC,EAAE,OAAe,0BAAS,CAAC,WAAW,EAAE,eAAyB,EAAE;QACtH,MAAM,QAAQ,GAAkB,CAAC,OAAoB,EAAE,EAAE;YACvD,MAAM,WAAW,GAAG,IAAA,2CAAqB,EAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;YACvE,OAAO,OAAO,CAAC,OAAO,CACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,aAAa;gBACrD,OAAO,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;gBACxC,gBAAgB,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,EAAE,iBAAiB,CAAC,CAC5D,CAAA;QACH,CAAC,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAA,2CAAuB,EAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QACzF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAE,OAAmC,EAAE,OAAe,0BAAS,CAAC,WAAW,EAAE,eAAyB,EAAE;QACnH,MAAM,QAAQ,GAAkB,CAAC,OAAoB,EAAE,EAAE;YACvD,OAAO,OAAO,CAAC,OAAO,CACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,KAAK;gBAC7C,OAAO,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;gBACxC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,uCAAuC,CAAC,CACjF,CAAA;QACH,CAAC,CAAA;QACD,MAAM,YAAY,GAAyB,KAAK,EAAE,OAAoB,EAAE,KAAa,EAAE,EAAE;YACvF,MAAM,OAAO,CAAC,IAAI,mCAAgB,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAwB,CAAC,CAAA;QAChG,CAAC,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QACrE,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAE,OAA0C,EAAE,OAAe,0BAAS,CAAC,WAAW,EAAE,eAAyB,EAAE;QAC5H,MAAM,QAAQ,GAAkB,CAAC,OAAoB,EAAE,EAAE;YACvD,OAAO,OAAO,CAAC,OAAO,CACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,MAAM;gBAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;gBACxC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAC3E,CAAA;QACH,CAAC,CAAA;QACD,MAAM,YAAY,GAAyB,KAAK,EAAE,OAAoB,EAAE,KAAa,EAAE,EAAE;;YACvF,MAAM,KAAK,GAAG,CAAC,MAAA,OAAO,CAAC,QAAQ,CAAC,KAAK,mCAAI,EAAE,CAAiC,CAAA;YAC5E,MAAM,OAAO,CAAC,IAAI,mCAAgB,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;YAC1D,MAAM,cAAc,GAAG,IAAI,0BAAQ,CAAC,+BAAa,CAAC,cAAc,CAAC,CAAA;YACjE,cAAc,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAA;YACtC,MAAM,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QAC5C,CAAC,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QACpE,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AA5HD,0BA4HC"}

package/dist/src/models/index.d.ts

@@ -0,0 +1 @@
+export * from './readReceiptInfo';

package/dist/src/models/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./readReceiptInfo"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAC5D,kCAAkC;;;;;;;;;;;;;;;;AAElC,oDAAiC"}

package/dist/src/models/readReceiptInfo.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Class representing read receipt information.
+ */
+export declare class ReadReceiptInfo {
+    /**
+     * The ID of the last read message.
+     */
+    lastReadMessageId: string;
+    /**
+     * Creates an instance of ReadReceiptInfo.
+     * @param {string} [lastReadMessageId=''] - The ID of the last read message.
+     */
+    constructor(lastReadMessageId?: string);
+    /**
+     * Checks if a message has been read.
+     * @param {string} compareMessageId - The ID of the message to compare.
+     * @param {string} lastReadMessageId - The ID of the last read message.
+     * @returns {boolean} True if the message has been read, false otherwise.
+     */
+    static isMessageRead(compareMessageId: string, lastReadMessageId: string): boolean;
+    /**
+     * Checks if a message has been read using the instance's last read message ID.
+     * @param {string} compareMessageId - The ID of the message to compare.
+     * @returns {boolean} True if the message has been read, false otherwise.
+     */
+    isMessageRead(compareMessageId: string): boolean;
+}

package/dist/src/models/readReceiptInfo.js

@@ -0,0 +1,44 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadReceiptInfo = void 0;
+/**
+ * Class representing read receipt information.
+ */
+class ReadReceiptInfo {
+    /**
+     * Creates an instance of ReadReceiptInfo.
+     * @param {string} [lastReadMessageId=''] - The ID of the last read message.
+     */
+    constructor(lastReadMessageId = '') {
+        this.lastReadMessageId = lastReadMessageId;
+    }
+    /**
+     * Checks if a message has been read.
+     * @param {string} compareMessageId - The ID of the message to compare.
+     * @param {string} lastReadMessageId - The ID of the last read message.
+     * @returns {boolean} True if the message has been read, false otherwise.
+     */
+    static isMessageRead(compareMessageId, lastReadMessageId) {
+        if (compareMessageId.trim().length === 0 || lastReadMessageId.trim().length === 0) {
+            return false;
+        }
+        const compareMessageIdNum = Number(compareMessageId);
+        const lastReadMessageIdNum = Number(lastReadMessageId);
+        if (!Number.isFinite(compareMessageIdNum) || !Number.isFinite(lastReadMessageIdNum)) {
+            return false;
+        }
+        return compareMessageIdNum <= lastReadMessageIdNum;
+    }
+    /**
+     * Checks if a message has been read using the instance's last read message ID.
+     * @param {string} compareMessageId - The ID of the message to compare.
+     * @returns {boolean} True if the message has been read, false otherwise.
+     */
+    isMessageRead(compareMessageId) {
+        return ReadReceiptInfo.isMessageRead(compareMessageId, this.lastReadMessageId);
+    }
+}
+exports.ReadReceiptInfo = ReadReceiptInfo;
+//# sourceMappingURL=readReceiptInfo.js.map

package/dist/src/models/readReceiptInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readReceiptInfo.js","sourceRoot":"","sources":["../../../src/models/readReceiptInfo.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAC5D,kCAAkC;;;AAElC;;GAEG;AACH,MAAa,eAAe;IAM1B;;;OAGG;IACH,YAAa,oBAA4B,EAAE;QACzC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAE,gBAAwB,EAAE,iBAAyB;QACvE,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,IAAI,iBAAiB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClF,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAA;QACpD,MAAM,oBAAoB,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAA;QAEtD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACpF,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,mBAAmB,IAAI,oBAAoB,CAAA;IACpD,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAE,gBAAwB;QACrC,OAAO,eAAe,CAAC,aAAa,CAAC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAChF,CAAC;CACF;AA3CD,0CA2CC"}

package/dist/src/taskModules/index.d.ts

@@ -0,0 +1 @@
+export * from './taskModule';

package/dist/src/taskModules/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./taskModule"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/taskModules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/taskModules/index.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAC5D,kCAAkC;;;;;;;;;;;;;;;;AAElC,+CAA4B"}

package/dist/src/taskModules/taskModule.d.ts

@@ -0,0 +1,42 @@
+import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
+import type { TaskModuleRequest, TaskModuleResponse } from '@microsoft/teams.api';
+import { TeamsTurnContext } from '../teamsTurnContext';
+type FetchHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, request: TaskModuleRequest) => Promise<TaskModuleResponse>;
+type SubmitHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, request: TaskModuleRequest) => Promise<TaskModuleResponse>;
+/**
+ * Registers handlers for Microsoft Teams task module invoke activities.
+ *
+ * @typeParam TState - The turn state type used by the agent application.
+ */
+export declare class TaskModule<TState extends TurnState> {
+    _app: AgentApplication<TState>;
+    /**
+     * Creates a Teams task module route helper.
+     *
+     * @param app - The agent application that receives the registered routes.
+     */
+    constructor(app: AgentApplication<TState>);
+    /**
+     * Registers a handler for Teams task/fetch invokes.
+     *
+     * @param value - Optional task data value or regular expression used to match the invoke.
+     * @param handler - Handler invoked with the task module request.
+     * @param key - Task data key to inspect when matching `value`. Defaults to `task`.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This task module helper for chaining.
+     */
+    onFetch(value: string | RegExp | null, handler: FetchHandler<TState>, key?: string, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams task/submit invokes.
+     *
+     * @param value - Optional task data value or regular expression used to match the invoke.
+     * @param handler - Handler invoked with the task module request.
+     * @param key - Task data key to inspect when matching `value`. Defaults to `task`.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This task module helper for chaining.
+     */
+    onSubmit(value: string | RegExp | null, handler: SubmitHandler<TState>, key?: string, rank?: number, authHandlers?: string[]): this;
+}
+export {};

package/dist/src/taskModules/taskModule.js

@@ -0,0 +1,102 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskModule = void 0;
+const agents_activity_1 = require("@microsoft/agents-activity");
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+const teamsTurnContext_1 = require("../teamsTurnContext");
+const DEFAULT_TASK_DATA_KEY = 'task';
+function matchesTaskKeyValue(context, value, key) {
+    var _a;
+    const taskData = (_a = context.activity.value) === null || _a === void 0 ? void 0 : _a.data;
+    if (!taskData || typeof taskData !== 'object')
+        return false;
+    const dataValue = taskData[normalizeTaskDataKey(key)];
+    if (typeof dataValue !== 'string')
+        return false;
+    return typeof value === 'string' ? dataValue === value : value.test(dataValue);
+}
+function isTaskInvoke(context, name) {
+    return (context.activity.type === agents_activity_1.ActivityTypes.Invoke &&
+        context.activity.channelId === 'msteams' &&
+        context.activity.name === name &&
+        context.activity.value != null);
+}
+function normalizeTaskDataKey(key) {
+    return key.trim() || DEFAULT_TASK_DATA_KEY;
+}
+function matchesTaskInvoke(context, name, value, key) {
+    if (!isTaskInvoke(context, name)) {
+        return false;
+    }
+    if (value == null || (typeof value === 'string' && value.trim() === '')) {
+        return true;
+    }
+    return matchesTaskKeyValue(context, value, key);
+}
+/**
+ * Registers handlers for Microsoft Teams task module invoke activities.
+ *
+ * @typeParam TState - The turn state type used by the agent application.
+ */
+class TaskModule {
+    /**
+     * Creates a Teams task module route helper.
+     *
+     * @param app - The agent application that receives the registered routes.
+     */
+    constructor(app) {
+        this._app = app;
+    }
+    /**
+     * Registers a handler for Teams task/fetch invokes.
+     *
+     * @param value - Optional task data value or regular expression used to match the invoke.
+     * @param handler - Handler invoked with the task module request.
+     * @param key - Task data key to inspect when matching `value`. Defaults to `task`.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This task module helper for chaining.
+     */
+    onFetch(value, handler, key = DEFAULT_TASK_DATA_KEY, rank = agents_hosting_1.RouteRank.Unspecified, authHandlers = []) {
+        const routeSel = (context) => {
+            return Promise.resolve(matchesTaskInvoke(context, 'task/fetch', value, key));
+        };
+        const routeHandler = async (context, state) => {
+            const request = context.activity.value;
+            const response = await handler(new teamsTurnContext_1.TeamsTurnContext(context), state, request);
+            const invokeResponse = new agents_activity_1.Activity(agents_activity_1.ActivityTypes.InvokeResponse);
+            invokeResponse.value = { status: 200, body: response };
+            await context.sendActivity(invokeResponse);
+        };
+        this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers);
+        return this;
+    }
+    /**
+     * Registers a handler for Teams task/submit invokes.
+     *
+     * @param value - Optional task data value or regular expression used to match the invoke.
+     * @param handler - Handler invoked with the task module request.
+     * @param key - Task data key to inspect when matching `value`. Defaults to `task`.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This task module helper for chaining.
+     */
+    onSubmit(value, handler, key = DEFAULT_TASK_DATA_KEY, rank = agents_hosting_1.RouteRank.Unspecified, authHandlers = []) {
+        const routeSel = (context) => {
+            return Promise.resolve(matchesTaskInvoke(context, 'task/submit', value, key));
+        };
+        const routeHandler = async (context, state) => {
+            const request = context.activity.value;
+            const response = await handler(new teamsTurnContext_1.TeamsTurnContext(context), state, request);
+            const invokeResponse = new agents_activity_1.Activity(agents_activity_1.ActivityTypes.InvokeResponse);
+            invokeResponse.value = { status: 200, body: response };
+            await context.sendActivity(invokeResponse);
+        };
+        this._app.addRoute(routeSel, routeHandler, true, rank, authHandlers);
+        return this;
+    }
+}
+exports.TaskModule = TaskModule;
+//# sourceMappingURL=taskModule.js.map

package/dist/src/taskModules/taskModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskModule.js","sourceRoot":"","sources":["../../../src/taskModules/taskModule.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAC5D,kCAAkC;;;AAElC,gEAAoE;AACpE,8DAA4H;AAE5H,0DAAsD;AAEtD,MAAM,qBAAqB,GAAG,MAAM,CAAA;AAEpC,SAAS,mBAAmB,CAAE,OAAoB,EAAE,KAAsB,EAAE,GAAW;;IACrF,MAAM,QAAQ,GAAG,MAAC,OAAO,CAAC,QAAQ,CAAC,KAAa,0CAAE,IAAI,CAAA;IACtD,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3D,MAAM,SAAS,GAAG,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAA;IACrD,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC/C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;AAChF,CAAC;AAED,SAAS,YAAY,CAAE,OAAoB,EAAE,IAAY;IACvD,OAAO,CACL,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,+BAAa,CAAC,MAAM;QAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS;QACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI;QAC9B,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAC/B,CAAA;AACH,CAAC;AAED,SAAS,oBAAoB,CAAE,GAAW;IACxC,OAAO,GAAG,CAAC,IAAI,EAAE,IAAI,qBAAqB,CAAA;AAC5C,CAAC;AAED,SAAS,iBAAiB,CAAE,OAAoB,EAAE,IAAY,EAAE,KAA6B,EAAE,GAAW;IACxG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QACxE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;AACjD,CAAC;AAKD;;;;GAIG;AACH,MAAa,UAAU;IAGrB;;;;OAIG;IACH,YAAa,GAA6B;QACxC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;IACjB,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAE,KAA6B,EAAE,OAA6B,EAAE,MAAc,qBAAqB,EAAE,OAAe,0BAAS,CAAC,WAAW,EAAE,eAAyB,EAAE;QAC3K,MAAM,QAAQ,GAAkB,CAAC,OAAoB,EAAE,EAAE;YACvD,OAAO,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;QAC9E,CAAC,CAAA;QACD,MAAM,YAAY,GAAyB,KAAK,EAAE,OAAoB,EAAE,KAAa,EAAE,EAAE;YACvF,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,KAA0B,CAAA;YAC3D,MAAM,QAAQ,GAAuB,MAAM,OAAO,CAAC,IAAI,mCAAgB,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;YACjG,MAAM,cAAc,GAAG,IAAI,0BAAQ,CAAC,+BAAa,CAAC,cAAc,CAAC,CAAA;YACjE,cAAc,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;YACtD,MAAM,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QAC5C,CAAC,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QACpE,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAE,KAA6B,EAAE,OAA8B,EAAE,MAAc,qBAAqB,EAAE,OAAe,0BAAS,CAAC,WAAW,EAAE,eAAyB,EAAE;QAC7K,MAAM,QAAQ,GAAkB,CAAC,OAAoB,EAAE,EAAE;YACvD,OAAO,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;QAC/E,CAAC,CAAA;QACD,MAAM,YAAY,GAAyB,KAAK,EAAE,OAAoB,EAAE,KAAa,EAAE,EAAE;YACvF,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,KAA0B,CAAA;YAC3D,MAAM,QAAQ,GAAuB,MAAM,OAAO,CAAC,IAAI,mCAAgB,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;YACjG,MAAM,cAAc,GAAG,IAAI,0BAAQ,CAAC,+BAAa,CAAC,cAAc,CAAC,CAAA;YACjE,cAAc,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;YACtD,MAAM,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QAC5C,CAAC,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QACpE,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AA7DD,gCA6DC"}

package/dist/src/teams/index.d.ts

@@ -0,0 +1 @@
+export * from './teamsTeam';

package/dist/src/teams/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./teamsTeam"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/teams/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/teams/index.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAC5D,kCAAkC;;;;;;;;;;;;;;;;AAElC,8CAA2B"}

package/dist/src/teams/teamsTeam.d.ts

@@ -0,0 +1,82 @@
+import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
+import type { TeamInfo } from '@microsoft/teams.api';
+import { TeamsTurnContext } from '../teamsTurnContext';
+type TeamUpdateHandler<TState extends TurnState> = (context: TeamsTurnContext, state: TState, data: TeamInfo) => Promise<void>;
+/**
+ * Registers handlers for Microsoft Teams team lifecycle events.
+ *
+ * @typeParam TState - The turn state type used by the agent application.
+ */
+export declare class TeamsTeam<TState extends TurnState = TurnState> {
+    private _app;
+    /**
+     * Creates a Teams team route helper.
+     *
+     * @param app - The agent application that receives the registered routes.
+     */
+    constructor(app: AgentApplication<TState>);
+    /**
+     * Registers a handler for any Teams team update event.
+     *
+     * @param handler - Handler invoked with the Teams turn context, turn state, and team information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This team helper for chaining.
+     */
+    onTeamEventReceived(handler: TeamUpdateHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams team archived events.
+     *
+     * @param handler - Handler invoked with the archived team information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This team helper for chaining.
+     */
+    onArchived(handler: TeamUpdateHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams team unarchived events.
+     *
+     * @param handler - Handler invoked with the unarchived team information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This team helper for chaining.
+     */
+    onUnarchived(handler: TeamUpdateHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams team renamed events.
+     *
+     * @param handler - Handler invoked with the renamed team information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This team helper for chaining.
+     */
+    onRenamed(handler: TeamUpdateHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams team restored events.
+     *
+     * @param handler - Handler invoked with the restored team information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This team helper for chaining.
+     */
+    onRestored(handler: TeamUpdateHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams team deleted events.
+     *
+     * @param handler - Handler invoked with the deleted team information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This team helper for chaining.
+     */
+    onDeleted(handler: TeamUpdateHandler<TState>, rank?: number, authHandlers?: string[]): this;
+    /**
+     * Registers a handler for Teams team hard-deleted events.
+     *
+     * @param handler - Handler invoked with the hard-deleted team information.
+     * @param rank - Optional route rank used for route ordering.
+     * @param authHandlers - Optional authorization handlers required by the route.
+     * @returns This team helper for chaining.
+     */
+    onHardDeleted(handler: TeamUpdateHandler<TState>, rank?: number, authHandlers?: string[]): this;
+}
+export {};