@microsoft/agents-hosting 0.5.1-g2e246ff274 → 0.5.12-g2d752e9b13

package/dist/src/app/streaming/streamingResponse.js

@@ -0,0 +1,333 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamingResponse = void 0;
+const agents_activity_1 = require("@microsoft/agents-activity");
+const citationUtil_1 = require("./citationUtil");
+const logger_1 = require("../../logger");
+const logger = (0, logger_1.debug)('agents:streamingResponse');
+/**
+ * A helper class for streaming responses to the client.
+ * @remarks
+ * This class is used to send a series of updates to the client in a single response. The expected
+ * sequence of calls is:
+ *
+ * `queueInformativeUpdate()`, `queueTextChunk()`, `queueTextChunk()`, ..., `endStream()`.
+ *
+ * Once `endStream()` is called, the stream is considered ended and no further updates can be sent.
+ */
+class StreamingResponse {
+    /**
+       * Creates a new StreamingResponse instance.
+       * @param {TurnContext} context - Context for the current turn of conversation with the user.
+       * @returns {TurnContext} - The context for the current turn of conversation with the user.
+       */
+    constructor(context) {
+        this._nextSequence = 1;
+        this._message = '';
+        this._ended = false;
+        // Queue for outgoing activities
+        this._queue = [];
+        this._chunkQueued = false;
+        // Powered by AI feature flags
+        this._enableFeedbackLoop = false;
+        this._enableGeneratedByAILabel = false;
+        this._citations = [];
+        this._context = context;
+    }
+    /**
+       * Gets the stream ID of the current response.
+       * @returns {string | undefined} - The stream ID of the current response.
+       * @remarks
+       * Assigned after the initial update is sent.
+       */
+    get streamId() {
+        return this._streamId;
+    }
+    /**
+       * Gets the citations of the current response.
+       */
+    get citations() {
+        return this._citations;
+    }
+    /**
+       * Gets the number of updates sent for the stream.
+       * @returns {number} - The number of updates sent for the stream.
+       */
+    get updatesSent() {
+        return this._nextSequence - 1;
+    }
+    /**
+       * Queues an informative update to be sent to the client.
+       * @param {string} text Text of the update to send.
+       */
+    queueInformativeUpdate(text) {
+        if (this._ended) {
+            throw new Error('The stream has already ended.');
+        }
+        // Queue a typing activity
+        this.queueActivity(() => agents_activity_1.Activity.fromObject({
+            type: 'typing',
+            text,
+            channelData: {
+                streamType: 'informative',
+                streamSequence: this._nextSequence++
+            }
+        }));
+    }
+    /**
+       * Queues a chunk of partial message text to be sent to the client
+       * @remarks
+       * The text we be sent as quickly as possible to the client. Chunks may be combined before
+       * delivery to the client.
+       * @param {string} text Partial text of the message to send.
+       * @param {Citation[]} citations Citations to be included in the message.
+       */
+    queueTextChunk(text, citations) {
+        if (this._ended) {
+            throw new Error('The stream has already ended.');
+        }
+        // Update full message text
+        this._message += text;
+        // If there are citations, modify the content so that the sources are numbers instead of [doc1], [doc2], etc.
+        this._message = citationUtil_1.CitationUtil.formatCitationsResponse(this._message);
+        // Queue the next chunk
+        this.queueNextChunk();
+    }
+    /**
+       * Ends the stream by sending the final message to the client.
+       * @returns {Promise<void>} - A promise representing the async operation
+       */
+    endStream() {
+        if (this._ended) {
+            throw new Error('The stream has already ended.');
+        }
+        // Queue final message
+        this._ended = true;
+        this.queueNextChunk();
+        // Wait for the queue to drain
+        return this.waitForQueue();
+    }
+    /**
+       * Sets the attachments to attach to the final chunk.
+       * @param attachments List of attachments.
+       */
+    setAttachments(attachments) {
+        this._attachments = attachments;
+    }
+    /**
+       * Sets the sensitivity label to attach to the final chunk.
+       * @param sensitivityLabel The sensitivty label.
+       */
+    setSensitivityLabel(sensitivityLabel) {
+        this._sensitivityLabel = sensitivityLabel;
+    }
+    /**
+       * Sets the citations for the full message.
+       * @param {Citation[]} citations Citations to be included in the message.
+       */
+    setCitations(citations) {
+        if (citations.length > 0) {
+            if (!this._citations) {
+                this._citations = [];
+            }
+            let currPos = this._citations.length;
+            for (const citation of citations) {
+                const clientCitation = {
+                    '@type': 'Claim',
+                    position: currPos + 1,
+                    appearance: {
+                        '@type': 'DigitalDocument',
+                        name: citation.title || `Document #${currPos + 1}`,
+                        abstract: citationUtil_1.CitationUtil.snippet(citation.content, 477)
+                    }
+                };
+                currPos++;
+                this._citations.push(clientCitation);
+            }
+        }
+    }
+    /**
+       * Sets the Feedback Loop in Teams that allows a user to
+       * give thumbs up or down to a response.
+       * Default is `false`.
+       * @param enableFeedbackLoop If true, the feedback loop is enabled.
+       */
+    setFeedbackLoop(enableFeedbackLoop) {
+        this._enableFeedbackLoop = enableFeedbackLoop;
+    }
+    /**
+       * Sets the type of UI to use for the feedback loop.
+       * @param feedbackLoopType The type of the feedback loop.
+       */
+    setFeedbackLoopType(feedbackLoopType) {
+        this._feedbackLoopType = feedbackLoopType;
+    }
+    /**
+       * Sets the the Generated by AI label in Teams
+       * Default is `false`.
+       * @param enableGeneratedByAILabel If true, the label is added.
+       */
+    setGeneratedByAILabel(enableGeneratedByAILabel) {
+        this._enableGeneratedByAILabel = enableGeneratedByAILabel;
+    }
+    /**
+       * Returns the most recently streamed message.
+       * @returns The streamed message.
+       */
+    getMessage() {
+        return this._message;
+    }
+    /**
+       * Waits for the outgoing activity queue to be empty.
+       * @returns {Promise<void>} - A promise representing the async operation.
+       */
+    waitForQueue() {
+        return this._queueSync || Promise.resolve();
+    }
+    /**
+       * Queues the next chunk of text to be sent to the client.
+       * @private
+       */
+    queueNextChunk() {
+        // Are we already waiting to send a chunk?
+        if (this._chunkQueued) {
+            return;
+        }
+        // Queue a chunk of text to be sent
+        this._chunkQueued = true;
+        this.queueActivity(() => {
+            this._chunkQueued = false;
+            if (this._ended) {
+                // Send final message
+                return agents_activity_1.Activity.fromObject({
+                    type: 'message',
+                    text: this._message || 'end strean response',
+                    attachments: this._attachments,
+                    channelData: {
+                        streamType: 'final',
+                        streamSequence: this._nextSequence++
+                    }
+                });
+            }
+            else {
+                // Send typing activity
+                return agents_activity_1.Activity.fromObject({
+                    type: 'typing',
+                    text: this._message,
+                    channelData: {
+                        streamType: 'streaming',
+                        streamSequence: this._nextSequence++
+                    }
+                });
+            }
+        });
+    }
+    /**
+       * Queues an activity to be sent to the client.
+       */
+    queueActivity(factory) {
+        this._queue.push(factory);
+        // If there's no sync in progress, start one
+        if (!this._queueSync) {
+            this._queueSync = this.drainQueue().catch((err) => {
+                logger.error(`Error occured when sending activity while streaming: "${err}".`);
+                // throw err
+            });
+        }
+    }
+    /**
+       * Sends any queued activities to the client until the queue is empty.
+       * @returns {Promise<void>} - A promise that will be resolved once the queue is empty.
+       * @private
+       */
+    async drainQueue() {
+        // eslint-disable-next-line no-async-promise-executor
+        return new Promise(async (resolve, reject) => {
+            try {
+                logger.debug(`Draining queue with ${this._queue.length} activities.`);
+                while (this._queue.length > 0) {
+                    const factory = this._queue.shift();
+                    const activity = factory();
+                    await this.sendActivity(activity);
+                }
+                resolve();
+            }
+            catch (err) {
+                reject(err);
+            }
+            finally {
+                this._queueSync = undefined;
+            }
+        });
+    }
+    /**
+       * Sends an activity to the client and saves the stream ID returned.
+       * @param {Activity} activity - The activity to send.
+       * @returns {Promise<void>} - A promise representing the async operation.
+       * @private
+       */
+    async sendActivity(activity) {
+        var _a;
+        // Set activity ID to the assigned stream ID
+        if (this._streamId) {
+            activity.id = this._streamId;
+            activity.channelData = Object.assign({}, activity.channelData, { streamId: this._streamId });
+        }
+        activity.entities = [
+            {
+                type: 'streaminfo',
+                ...activity.channelData
+            }
+        ];
+        if (this._citations && this._citations.length > 0 && !this._ended) {
+            // Filter out the citations unused in content.
+            const currCitations = (_a = citationUtil_1.CitationUtil.getUsedCitations(this._message, this._citations)) !== null && _a !== void 0 ? _a : undefined;
+            activity.entities.push({
+                type: 'https://schema.org/Message',
+                '@type': 'Message',
+                '@context': 'https://schema.org',
+                '@id': '',
+                citation: currCitations
+            });
+        }
+        // Add in Powered by AI feature flags
+        if (this._ended) {
+            if (this._enableFeedbackLoop && this._feedbackLoopType) {
+                activity.channelData = Object.assign({}, activity.channelData, {
+                    feedbackLoop: { type: this._feedbackLoopType }
+                });
+            }
+            else {
+                activity.channelData = Object.assign({}, activity.channelData, {
+                    feedbackLoopEnabled: this._enableFeedbackLoop
+                });
+            }
+            // Add in Generated by AI
+            if (this._enableGeneratedByAILabel) {
+                (0, agents_activity_1.addAIToActivity)(activity, this._citations, this._sensitivityLabel);
+                // activity.entities.push({
+                //   type: 'https://schema.org/Message',
+                //   '@type': 'Message',
+                //   '@context': 'https://schema.org',
+                //   '@id': '',
+                //   additionalType: ['AIGeneratedContent'],
+                //   citation: this._citations && this._citations.length > 0 ? this._citations : [],
+                //   usageInfo: this._sensitivityLabel
+                // } as unknown as Entity)
+            }
+        }
+        // Send activity
+        const response = await this._context.sendActivity(activity);
+        await new Promise((resolve) => setTimeout(resolve, 1500));
+        // Save assigned stream ID
+        if (!this._streamId) {
+            this._streamId = response === null || response === void 0 ? void 0 : response.id;
+        }
+    }
+}
+exports.StreamingResponse = StreamingResponse;
+//# sourceMappingURL=streamingResponse.js.map

package/dist/src/app/streaming/streamingResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamingResponse.js","sourceRoot":"","sources":["../../../../src/app/streaming/streamingResponse.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,gEAA0F;AAG1F,iDAA6C;AAC7C,yCAAoC;AAGpC,MAAM,MAAM,GAAG,IAAA,cAAK,EAAC,0BAA0B,CAAC,CAAA;AAEhD;;;;;;;;;GASG;AACH,MAAa,iBAAiB;IAoB5B;;;;SAIK;IACL,YAAoB,OAAoB;QAvBhC,kBAAa,GAAW,CAAC,CAAA;QAEzB,aAAQ,GAAW,EAAE,CAAA;QAErB,WAAM,GAAG,KAAK,CAAA;QAEtB,gCAAgC;QACxB,WAAM,GAA0B,EAAE,CAAA;QAElC,iBAAY,GAAG,KAAK,CAAA;QAE5B,8BAA8B;QACtB,wBAAmB,GAAG,KAAK,CAAA;QAE3B,8BAAyB,GAAG,KAAK,CAAA;QACjC,eAAU,GAAsB,EAAE,CAAA;QASxC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED;;;;;SAKK;IACL,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED;;SAEK;IACL,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;SAGK;IACL,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED;;;SAGK;IACE,sBAAsB,CAAE,IAAY;QACzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,0BAA0B;QAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,0BAAQ,CAAC,UAAU,CAAC;YAC3C,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,WAAW,EAAE;gBACX,UAAU,EAAE,aAAa;gBACzB,cAAc,EAAE,IAAI,CAAC,aAAa,EAAE;aACb;SAC1B,CAAC,CAAC,CAAA;IACL,CAAC;IAED;;;;;;;SAOK;IACE,cAAc,CAAE,IAAY,EAAE,SAAsB;QACzD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,2BAA2B;QAC3B,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAA;QAErB,6GAA6G;QAC7G,IAAI,CAAC,QAAQ,GAAG,2BAAY,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEnE,uBAAuB;QACvB,IAAI,CAAC,cAAc,EAAE,CAAA;IACvB,CAAC;IAED;;;SAGK;IACE,SAAS;QACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,sBAAsB;QACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,CAAC,cAAc,EAAE,CAAA;QAErB,8BAA8B;QAC9B,OAAO,IAAI,CAAC,YAAY,EAAE,CAAA;IAC5B,CAAC;IAED;;;SAGK;IACE,cAAc,CAAE,WAAyB;QAC9C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;IACjC,CAAC;IAED;;;SAGK;IACE,mBAAmB,CAAE,gBAAsC;QAChE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;IAC3C,CAAC;IAED;;;SAGK;IACE,YAAY,CAAE,SAAqB;QACxC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBACrB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;YACtB,CAAC;YACD,IAAI,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAA;YAEpC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,MAAM,cAAc,GAAmB;oBACrC,OAAO,EAAE,OAAO;oBAChB,QAAQ,EAAE,OAAO,GAAG,CAAC;oBACrB,UAAU,EAAE;wBACV,OAAO,EAAE,iBAAiB;wBAC1B,IAAI,EAAE,QAAQ,CAAC,KAAK,IAAI,aAAa,OAAO,GAAG,CAAC,EAAE;wBAClD,QAAQ,EAAE,2BAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC;qBACtD;iBACF,CAAA;gBACD,OAAO,EAAE,CAAA;gBACT,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;SAKK;IACE,eAAe,CAAE,kBAA2B;QACjD,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAA;IAC/C,CAAC;IAED;;;SAGK;IACE,mBAAmB,CAAE,gBAAsC;QAChE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;IAC3C,CAAC;IAED;;;;SAIK;IACE,qBAAqB,CAAE,wBAAiC;QAC7D,IAAI,CAAC,yBAAyB,GAAG,wBAAwB,CAAA;IAC3D,CAAC;IAED;;;SAGK;IACE,UAAU;QACf,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;;SAGK;IACE,YAAY;QACjB,OAAO,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;IAC7C,CAAC;IAED;;;SAGK;IACG,cAAc;QACpB,0CAA0C;QAC1C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,OAAM;QACR,CAAC;QAED,mCAAmC;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;QACxB,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;YACtB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;YACzB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,qBAAqB;gBACrB,OAAO,0BAAQ,CAAC,UAAU,CAAC;oBACzB,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,IAAI,CAAC,QAAQ,IAAI,qBAAqB;oBAC5C,WAAW,EAAE,IAAI,CAAC,YAAY;oBAC9B,WAAW,EAAE;wBACX,UAAU,EAAE,OAAO;wBACnB,cAAc,EAAE,IAAI,CAAC,aAAa,EAAE;qBACb;iBAC1B,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,uBAAuB;gBACvB,OAAO,0BAAQ,CAAC,UAAU,CAAC;oBACzB,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,IAAI,CAAC,QAAQ;oBACnB,WAAW,EAAE;wBACX,UAAU,EAAE,WAAW;wBACvB,cAAc,EAAE,IAAI,CAAC,aAAa,EAAE;qBACb;iBAC1B,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;SAEK;IACG,aAAa,CAAE,OAAuB;QAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEzB,4CAA4C;QAC5C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAChD,MAAM,CAAC,KAAK,CAAC,yDAAyD,GAAG,IAAI,CAAC,CAAA;gBAC9E,YAAY;YACd,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;SAIK;IACG,KAAK,CAAC,UAAU;QACtB,qDAAqD;QACrD,OAAO,IAAI,OAAO,CAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YACjD,IAAI,CAAC;gBACH,MAAM,CAAC,KAAK,CAAC,uBAAuB,IAAI,CAAC,MAAM,CAAC,MAAM,cAAc,CAAC,CAAA;gBACrE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAG,CAAA;oBACpC,MAAM,QAAQ,GAAG,OAAO,EAAE,CAAA;oBAC1B,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;gBACnC,CAAC;gBAED,OAAO,EAAE,CAAA;YACX,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;YAC7B,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;SAKK;IACG,KAAK,CAAC,YAAY,CAAE,QAAkB;;QAC5C,4CAA4C;QAC5C,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAA;YAC5B,QAAQ,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QAC9F,CAAC;QAED,QAAQ,CAAC,QAAQ,GAAG;YAClB;gBACE,IAAI,EAAE,YAAY;gBAClB,GAAG,QAAQ,CAAC,WAAW;aACd;SACZ,CAAA;QAED,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAClE,8CAA8C;YAC9C,MAAM,aAAa,GAAG,MAAA,2BAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,mCAAI,SAAS,CAAA;YAChG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACrB,IAAI,EAAE,4BAA4B;gBAClC,OAAO,EAAE,SAAS;gBAClB,UAAU,EAAE,oBAAoB;gBAChC,KAAK,EAAE,EAAE;gBACT,QAAQ,EAAE,aAAa;aACH,CAAC,CAAA;QACzB,CAAC;QAED,qCAAqC;QACrC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvD,QAAQ,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE;oBAC7D,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE;iBAC/C,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE;oBAC7D,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;iBAC9C,CAAC,CAAA;YACJ,CAAC;YAED,yBAAyB;YACzB,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACnC,IAAA,iCAAe,EAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;gBAClE,2BAA2B;gBAC3B,wCAAwC;gBACxC,wBAAwB;gBACxB,sCAAsC;gBACtC,eAAe;gBACf,4CAA4C;gBAC5C,oFAAoF;gBACpF,sCAAsC;gBACtC,0BAA0B;YAC5B,CAAC;QACH,CAAC;QAED,gBAAgB;QAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC3D,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAA;QAEzD,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,EAAE,CAAA;QAC/B,CAAC;IACH,CAAC;CACF;AA3VD,8CA2VC"}

package/dist/src/cards/cardFactory.d.ts

@@ -12,7 +12,7 @@ import { O365ConnectorCard } from './o365ConnectorCard';
 import { ThumbnailCard } from './thumbnailCard';
 import { VideoCard } from './videoCard';
 import { CardImage } from './cardImage';
-import { SigningResource } from '../oauth/signingResource';
+import { SignInResource } from '../oauth/userTokenClient.types';
 /**
  * Factory class for creating various types of cards.
  */
@@ -106,7 +106,7 @@ export declare class CardFactory {
      * @param signingResource The signing resource.
      * @returns The OAuth card attachment.
      */
-    static oauthCard(connectionName: string, title: string, text: string, signingResource: SigningResource): Attachment;
+    static oauthCard(connectionName: string, title: string, text: string, signingResource: SignInResource): Attachment;
     /**
      * Creates a sign-in card attachment.
      * @param title The title of the card.

package/dist/src/cards/cardFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"cardFactory.js","sourceRoot":"","sources":["../../../src/cards/cardFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,gEAAgF;AAchF;;GAEG;AACH,MAAa,WAAW;IAiBtB;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAE,IAAS;QAC5B,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,aAAa,CAClB,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAA8B;QAE9B,OAAO,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IACpG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CACd,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAA0B;QAE1B,OAAO,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAChG,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAE,KAAa,EAAE,IAAU,EAAE,MAAY,EAAE,OAAa,EAAE,KAAyB;QAChG,MAAM,CAAC,GAAe,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QACpF,CAAC,CAAC,WAAW,GAAG,WAAW,CAAC,YAAY,CAAC,QAAQ,CAAA;QACjD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAE,IAAiB;QACnC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC7E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAE,IAAuB;QAC/C,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IACnF,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,CAClB,KAAa,EACb,IAAU,EACV,MAAY,EACZ,OAAa,EACb,KAA8B;QAE9B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,KAAK,GAAG,OAAO,CAAA;YACf,OAAO,GAAG,MAAM,CAAA;YAChB,MAAM,GAAG,IAAI,CAAA;YACb,IAAI,GAAG,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,IAAI,GAA2B,EAAE,GAAG,KAAK,EAAE,CAAA;QACjD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC;QACD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAClB,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC1C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC/E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CACd,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAA0B;QAE1B,OAAO,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAChG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAE,MAA0C;QACvD,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,GAAuB,EAAE,EAAE;YACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;YACzB,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAE,OAA4C;QAC1D,MAAM,IAAI,GAAiB,EAAE,CAAC;QAC9B,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAsB,EAAE,EAAE;YACjD,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC1B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACd,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC;oBACR,IAAI,EAAE,6BAAW,CAAC,MAAM;oBACxB,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE;oBACnB,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE;oBACnB,WAAW,EAAE,SAAS;iBACvB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAE,cAAsB,EAAE,KAAa,EAAE,IAAY,EAAE,eAAgC;QACrG,MAAM,IAAI,GAAuB;YAC/B,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,6BAAW,CAAC,MAAM;oBACxB,KAAK;oBACL,KAAK,EAAE,eAAe,CAAC,UAAU;oBACjC,WAAW,EAAE,SAAS;iBACvB,CAAC;YACF,cAAc;YACd,qBAAqB,EAAE,eAAe,CAAC,qBAAqB;YAC5D,iBAAiB,EAAE,eAAe,CAAC,iBAAiB;SACrD,CAAA;QACD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAClB,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC3E,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAE,KAAa,EAAE,GAAW,EAAE,IAAa;QAC1D,MAAM,IAAI,GAAe;YACvB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,6BAAW,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;SACnF,CAAA;QACD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAClB,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC5E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAE,KAAwC;QACpD,MAAM,IAAI,GAAe,EAAE,CAAC;QAC5B,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,GAAsB,EAAE,EAAE;YAC/C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;YACzB,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,SAAS,CACtB,WAAmB,EACnB,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAAW;QAEX,MAAM,IAAI,GAAc,EAAE,GAAG,KAAK,EAAE,CAAA;QACpC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACrC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IACvC,CAAC;;AAvRH,kCAwRC;AAvRC;;GAEG;AACI,wBAAY,GAAQ;IACzB,YAAY,EAAE,yCAAyC;IACvD,aAAa,EAAE,0CAA0C;IACzD,SAAS,EAAE,sCAAsC;IACjD,QAAQ,EAAE,qCAAqC;IAC/C,WAAW,EAAE,wCAAwC;IACrD,iBAAiB,EAAE,oDAAoD;IACvE,aAAa,EAAE,0CAA0C;IACzD,SAAS,EAAE,sCAAsC;IACjD,SAAS,EAAE,sCAAsC;IACjD,UAAU,EAAE,uCAAuC;CACpD,CAAA"}
+{"version":3,"file":"cardFactory.js","sourceRoot":"","sources":["../../../src/cards/cardFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,gEAAgF;AAahF;;GAEG;AACH,MAAa,WAAW;IAiBtB;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAE,IAAS;QAC5B,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,aAAa,CAClB,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAA8B;QAE9B,OAAO,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IACpG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CACd,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAA0B;QAE1B,OAAO,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAChG,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAE,KAAa,EAAE,IAAU,EAAE,MAAY,EAAE,OAAa,EAAE,KAAyB;QAChG,MAAM,CAAC,GAAe,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QACpF,CAAC,CAAC,WAAW,GAAG,WAAW,CAAC,YAAY,CAAC,QAAQ,CAAA;QACjD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAE,IAAiB;QACnC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC7E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAE,IAAuB;QAC/C,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IACnF,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,CAClB,KAAa,EACb,IAAU,EACV,MAAY,EACZ,OAAa,EACb,KAA8B;QAE9B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,KAAK,GAAG,OAAO,CAAA;YACf,OAAO,GAAG,MAAM,CAAA;YAChB,MAAM,GAAG,IAAI,CAAA;YACb,IAAI,GAAG,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,IAAI,GAA2B,EAAE,GAAG,KAAK,EAAE,CAAA;QACjD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC;QACD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAClB,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC1C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC/E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CACd,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAA0B;QAE1B,OAAO,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAChG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAE,MAA0C;QACvD,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,GAAuB,EAAE,EAAE;YACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;YACzB,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAE,OAA4C;QAC1D,MAAM,IAAI,GAAiB,EAAE,CAAC;QAC9B,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAsB,EAAE,EAAE;YACjD,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC1B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACd,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC;oBACR,IAAI,EAAE,6BAAW,CAAC,MAAM;oBACxB,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE;oBACnB,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE;oBACnB,WAAW,EAAE,SAAS;iBACvB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAE,cAAsB,EAAE,KAAa,EAAE,IAAY,EAAE,eAA+B;QACpG,MAAM,IAAI,GAAuB;YAC/B,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,6BAAW,CAAC,MAAM;oBACxB,KAAK;oBACL,KAAK,EAAE,eAAe,CAAC,UAAU;oBACjC,WAAW,EAAE,SAAS;iBACvB,CAAC;YACF,cAAc;YACd,qBAAqB,EAAE,eAAe,CAAC,qBAAqB;YAC5D,iBAAiB,EAAE,eAAe,CAAC,iBAAiB;SACrD,CAAA;QACD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAClB,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC3E,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAE,KAAa,EAAE,GAAW,EAAE,IAAa;QAC1D,MAAM,IAAI,GAAe;YACvB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,6BAAW,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;SACnF,CAAA;QACD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAClB,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC5E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAE,KAAwC;QACpD,MAAM,IAAI,GAAe,EAAE,CAAC;QAC5B,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,GAAsB,EAAE,EAAE;YAC/C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;YACzB,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,SAAS,CACtB,WAAmB,EACnB,KAAa,EACb,KAA4B,EAC5B,OAAiC,EACjC,KAAW;QAEX,MAAM,IAAI,GAAc,EAAE,GAAG,KAAK,EAAE,CAAA;QACpC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACrC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IACvC,CAAC;;AAvRH,kCAwRC;AAvRC;;GAEG;AACI,wBAAY,GAAQ;IACzB,YAAY,EAAE,yCAAyC;IACvD,aAAa,EAAE,0CAA0C;IACzD,SAAS,EAAE,sCAAsC;IACjD,QAAQ,EAAE,qCAAqC;IAC/C,WAAW,EAAE,wCAAwC;IACrD,iBAAiB,EAAE,oDAAoD;IACvE,aAAa,EAAE,0CAA0C;IACzD,SAAS,EAAE,sCAAsC;IACjD,SAAS,EAAE,sCAAsC;IACjD,UAAU,EAAE,uCAAuC;CACpD,CAAA"}

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

@@ -1,6 +1,3 @@
-export * from './oAuthCard';
-export * from './signingResource';
 export * from './userTokenClient';
-export * from './tokenExchangeRequest';
 export * from './oAuthFlow';
-export * from './tokenResponse';
+export * from './userTokenClient.types';

package/dist/src/oauth/index.js

@@ -14,10 +14,7 @@ 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("./oAuthCard"), exports);
-__exportStar(require("./signingResource"), exports);
 __exportStar(require("./userTokenClient"), exports);
-__exportStar(require("./tokenExchangeRequest"), exports);
 __exportStar(require("./oAuthFlow"), exports);
-__exportStar(require("./tokenResponse"), exports);
+__exportStar(require("./userTokenClient.types"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/oauth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,oDAAiC;AACjC,oDAAiC;AACjC,yDAAsC;AACtC,8CAA2B;AAC3B,kDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/oauth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,8CAA2B;AAC3B,0DAAuC"}

package/dist/src/oauth/oAuthFlow.d.ts

@@ -1,6 +1,7 @@
-import { AgentStatePropertyAccessor, UserState, TurnContext, UserTokenClient } from '../';
-import { TokenResponse } from './tokenResponse';
-export declare class FlowState {
+import { TurnContext, Storage } from '../';
+import { UserTokenClient } from './userTokenClient';
+import { TokenResponse } from './userTokenClient.types';
+export interface FlowState {
     flowStarted: boolean;
     flowExpires: number;
 }
@@ -8,6 +9,7 @@ export declare class FlowState {
  * Manages the OAuth flow
  */
 export declare class OAuthFlow {
+    private storage;
     /**
      * The user token client used for managing user tokens.
      */
@@ -15,11 +17,7 @@ export declare class OAuthFlow {
     /**
      * The current state of the OAuth flow.
      */
-    state: FlowState | null;
-    /**
-     * The accessor for managing the flow state in user state.
-     */
-    flowStateAccessor: AgentStatePropertyAccessor<FlowState | null>;
+    state: FlowState;
     /**
      * The ID of the token exchange request, used to deduplicate requests.
      */
@@ -40,7 +38,7 @@ export declare class OAuthFlow {
      * Creates a new instance of OAuthFlow.
      * @param userState The user state.
      */
-    constructor(userState: UserState, absOauthConnectionName: string, tokenClient?: UserTokenClient, cardTitle?: string, cardText?: string);
+    constructor(storage: Storage, absOauthConnectionName: string, tokenClient?: UserTokenClient, cardTitle?: string, cardText?: string);
     /**
      * Retrieves the user token from the user token service.
      * @param context The turn context containing the activity information.
@@ -53,7 +51,7 @@ export declare class OAuthFlow {
      * @param context The turn context.
      * @returns A promise that resolves to the user token.
      */
-    beginFlow(context: TurnContext): Promise<TokenResponse>;
+    beginFlow(context: TurnContext): Promise<TokenResponse | undefined>;
     /**
      * Continues the OAuth flow.
      * @param context The turn context.
@@ -73,4 +71,5 @@ export declare class OAuthFlow {
      */
     private getUserState;
     private initializeTokenClient;
+    private getFlowStateKey;
 }

package/dist/src/oauth/oAuthFlow.js

@@ -1,20 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OAuthFlow = exports.FlowState = void 0;
+exports.OAuthFlow = void 0;
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 const logger_1 = require("./../logger");
 const agents_activity_1 = require("@microsoft/agents-activity");
 const __1 = require("../");
-const tokenResponse_1 = require("./tokenResponse");
+const userTokenClient_1 = require("./userTokenClient");
 const logger = (0, logger_1.debug)('agents:oauth-flow');
-class FlowState {
-    constructor() {
-        this.flowStarted = false;
-        this.flowExpires = 0;
-    }
-}
-exports.FlowState = FlowState;
 /**
  * Manages the OAuth flow
  */
@@ -23,7 +16,8 @@ class OAuthFlow {
      * Creates a new instance of OAuthFlow.
      * @param userState The user state.
      */
-    constructor(userState, absOauthConnectionName, tokenClient, cardTitle, cardText) {
+    constructor(storage, absOauthConnectionName, tokenClient, cardTitle, cardText) {
+        this.storage = storage;
         /**
          * The ID of the token exchange request, used to deduplicate requests.
          */
@@ -36,8 +30,7 @@ class OAuthFlow {
          * The text of the OAuth card.
          */
         this.cardText = 'login';
-        this.state = new FlowState();
-        this.flowStateAccessor = userState.createProperty('flowState');
+        this.state = { flowExpires: 0, flowStarted: false };
         this.absOauthConnectionName = absOauthConnectionName;
         this.userTokenClient = tokenClient !== null && tokenClient !== void 0 ? tokenClient : null;
         this.cardTitle = cardTitle !== null && cardTitle !== void 0 ? cardTitle : this.cardTitle;
@@ -73,26 +66,20 @@ class OAuthFlow {
         }
         logger.info('Starting OAuth flow for connectionName:', this.absOauthConnectionName);
         await this.initializeTokenClient(context);
-        const tokenResponse = await this.userTokenClient.getUserToken(this.absOauthConnectionName, context.activity.channelId, (_a = context.activity.from) === null || _a === void 0 ? void 0 : _a.id);
-        if ((tokenResponse === null || tokenResponse === void 0 ? void 0 : tokenResponse.status) === tokenResponse_1.TokenRequestStatus.Success) {
+        const act = context.activity;
+        const output = await this.userTokenClient.getTokenOrSignInResource((_a = act.from) === null || _a === void 0 ? void 0 : _a.id, this.absOauthConnectionName, act.channelId, act.getConversationReference(), act.relatesTo, undefined);
+        if (output && output.tokenResponse) {
             this.state.flowStarted = false;
             this.state.flowExpires = 0;
-            await this.flowStateAccessor.set(context, this.state);
-            logger.info('User token retrieved successfully from service');
-            return tokenResponse;
+            await this.storage.write({ [this.getFlowStateKey(context)]: this.state });
+            return output.tokenResponse;
         }
-        const authConfig = context.adapter.authConfig;
-        const signingResource = await this.userTokenClient.getSignInResource(authConfig.clientId, this.absOauthConnectionName, context.activity.getConversationReference(), context.activity.relatesTo);
-        const oCard = __1.CardFactory.oauthCard(this.absOauthConnectionName, this.cardTitle, this.cardText, signingResource);
+        const oCard = __1.CardFactory.oauthCard(this.absOauthConnectionName, this.cardTitle, this.cardText, output.signInResource);
         await context.sendActivity(__1.MessageFactory.attachment(oCard));
         this.state.flowStarted = true;
         this.state.flowExpires = Date.now() + 30000;
-        await this.flowStateAccessor.set(context, this.state);
-        logger.info('OAuth begin flow completed, waiting for user to sign in');
-        return {
-            token: undefined,
-            status: tokenResponse_1.TokenRequestStatus.InProgress
-        };
+        await this.storage.write({ [this.getFlowStateKey(context)]: this.state });
+        return undefined;
     }
     /**
      * Continues the OAuth flow.
@@ -107,7 +94,7 @@ class OAuthFlow {
             logger.warn('Flow expired');
             this.state.flowStarted = false;
             await context.sendActivity(__1.MessageFactory.text('Sign-in session expired. Please try again.'));
-            return { status: tokenResponse_1.TokenRequestStatus.Expired, token: undefined };
+            return { token: undefined };
         }
         const contFlowActivity = context.activity;
         if (contFlowActivity.type === agents_activity_1.ActivityTypes.Message) {
@@ -126,23 +113,23 @@ class OAuthFlow {
             logger.info('Continuing OAuth flow with tokenExchange');
             const tokenExchangeRequest = contFlowActivity.value;
             if (this.tokenExchangeId === tokenExchangeRequest.id) { // dedupe
-                return { status: tokenResponse_1.TokenRequestStatus.InProgress, token: undefined };
+                return { token: undefined };
             }
             this.tokenExchangeId = tokenExchangeRequest.id;
             const userTokenResp = await ((_f = this.userTokenClient) === null || _f === void 0 ? void 0 : _f.exchangeTokenAsync((_g = contFlowActivity.from) === null || _g === void 0 ? void 0 : _g.id, this.absOauthConnectionName, contFlowActivity.channelId, tokenExchangeRequest));
-            if ((userTokenResp === null || userTokenResp === void 0 ? void 0 : userTokenResp.status) === tokenResponse_1.TokenRequestStatus.Success) {
+            if (userTokenResp && userTokenResp.token) {
                 logger.info('Token exchanged');
                 this.state.flowStarted = false;
-                await this.flowStateAccessor.set(context, this.state);
+                await this.storage.write({ [this.getFlowStateKey(context)]: this.state });
                 return userTokenResp;
             }
             else {
                 logger.warn('Token exchange failed');
                 this.state.flowStarted = true;
-                return { status: tokenResponse_1.TokenRequestStatus.Failed, token: undefined };
+                return { token: undefined };
             }
         }
-        return { status: tokenResponse_1.TokenRequestStatus.Failed, token: undefined };
+        return { token: undefined };
     }
     /**
      * Signs the user out.
@@ -155,7 +142,7 @@ class OAuthFlow {
         await this.initializeTokenClient(context);
         await ((_a = this.userTokenClient) === null || _a === void 0 ? void 0 : _a.signOut((_b = context.activity.from) === null || _b === void 0 ? void 0 : _b.id, this.absOauthConnectionName, context.activity.channelId));
         this.state.flowExpires = 0;
-        await this.flowStateAccessor.set(context, this.state);
+        this.storage.write({ [this.getFlowStateKey(context)]: this.state });
         logger.info('User signed out successfully');
     }
     /**
@@ -164,18 +151,28 @@ class OAuthFlow {
      * @returns A promise that resolves to the user state.
      */
     async getUserState(context) {
-        let userProfile = await this.flowStateAccessor.get(context, null);
-        if (userProfile === null) {
-            userProfile = new FlowState();
-        }
+        var _a;
+        const key = this.getFlowStateKey(context);
+        const data = await this.storage.read([key]);
+        const userProfile = (_a = data[key]) !== null && _a !== void 0 ? _a : { flowStarted: false, flowExpires: 0 };
         return userProfile;
     }
     async initializeTokenClient(context) {
         if (this.userTokenClient === undefined || this.userTokenClient === null) {
             const scope = 'https://api.botframework.com';
             const accessToken = await context.adapter.authProvider.getAccessToken(context.adapter.authConfig, scope);
-            this.userTokenClient = new __1.UserTokenClient(accessToken);
+            this.userTokenClient = new userTokenClient_1.UserTokenClient(accessToken, context.adapter.authConfig.clientId);
+        }
+    }
+    getFlowStateKey(context) {
+        var _a, _b;
+        const channelId = context.activity.channelId;
+        const conversationId = (_a = context.activity.conversation) === null || _a === void 0 ? void 0 : _a.id;
+        const userId = (_b = context.activity.from) === null || _b === void 0 ? void 0 : _b.id;
+        if (!channelId || !conversationId || !userId) {
+            throw new Error('ChannelId, conversationId, and userId must be set in the activity');
         }
+        return `oauth/${channelId}/${conversationId}/${userId}/flowState`;
     }
 }
 exports.OAuthFlow = OAuthFlow;