@microsoft/agents-hosting 0.5.1-g2e246ff274 → 0.5.4-ga4d0401645

package/src/app/streaming/utilities.ts

@@ -0,0 +1,108 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ClientCitation } from './clientCitation'
+
+// import { stringify } from 'yaml'
+
+// import { Tokenizer } from './tokenizers'
+
+/**
+ * Utility functions for manipulating .
+ */
+export class Utilities {
+//   /**
+//      * Converts a value to a string.
+//      * @remarks
+//      * Dates are converted to ISO strings and Objects are converted to JSON or YAML, whichever is shorter.
+//      * @param {Tokenizer} tokenizer Tokenizer to use for encoding.
+//      * @param {any} value Value to convert.
+//      * @param {boolean} asJSON Optional. If true objects will always be converted to JSON instead of YAML. Defaults to false.
+//      * @returns {string} Converted value.
+//      */
+//   public static toString (tokenizer: Tokenizer, value: any, asJSON: boolean = false): string {
+//     if (value === undefined || value === null) {
+//       return ''
+//     } else if (typeof value === 'object') {
+//       if (typeof value.toISOString === 'function') {
+//         return value.toISOString()
+//       } else if (asJSON) {
+//         return JSON.stringify(value)
+//       } else {
+//         // Return shorter version of object
+//         const asYaml = stringify(value)
+//         const asJSON = JSON.stringify(value)
+//         if (tokenizer.encode(asYaml).length <= tokenizer.encode(asJSON).length) {
+//           return asYaml
+//         } else {
+//           return asJSON
+//         }
+//       }
+//     } else {
+//       return value.toString()
+//     }
+//   }
+
+  /**
+     *
+     * Clips the text to a maximum length in case it exceeds the limit.
+     * @param {string} text The text to clip.
+     * @param {number} maxLength The maximum length of the text to return, cutting off the last whole word.
+     * @returns {string} The modified text
+     */
+  public static snippet (text: string, maxLength: number): string {
+    if (text.length <= maxLength) {
+      return text
+    }
+    let snippet = text.slice(0, maxLength)
+    snippet = snippet.slice(0, Math.min(snippet.length, snippet.lastIndexOf(' ')))
+    snippet += '...'
+    return snippet
+  }
+
+  /**
+     * Convert citation tags `[doc(s)n]` to `[n]` where n is a number.
+     * @param {string} text The text to format.
+     * @returns {string} The formatted text.
+     */
+  public static formatCitationsResponse (text: string): string {
+    return text.replace(/\[docs?(\d+)\]/gi, '[$1]')
+  }
+
+  /**
+     * Get the citations used in the text. This will remove any citations that are included in the citations array from the response but not referenced in the text.
+     * @param {string} text - The text to search for citation references, i.e. [1], [2], etc.
+     * @param {ClientCitation[]} citations - The list of citations to search for.
+     * @returns {ClientCitation[] | undefined} The list of citations used in the text.
+     */
+  public static getUsedCitations (text: string, citations: ClientCitation[]): ClientCitation[] | undefined {
+    const regex = /\[(\d+)\]/gi
+    const matches = text.match(regex)
+
+    if (!matches) {
+      return undefined
+    }
+
+    // Remove duplicates
+    const filteredMatches = new Set()
+    matches.forEach((match) => {
+      if (filteredMatches.has(match)) {
+        return
+      }
+
+      filteredMatches.add(match)
+    })
+
+    // Add citations
+    const usedCitations: ClientCitation[] = []
+    filteredMatches.forEach((match) => {
+      const found = citations.find((citation) => `[${citation.position}]` === match)
+      if (found) {
+        usedCitations.push(found)
+      }
+    })
+    return usedCitations
+  }
+}

package/src/turnContext.ts

@@ -6,6 +6,7 @@ import { ResourceResponse } from './connector-client/resourceResponse'
 import { TurnContextStateCollection } from './turnContextStateCollection'
 import { AttachmentInfo } from './connector-client/attachmentInfo'
 import { AttachmentData } from './connector-client/attachmentData'
+import { StreamingResponse } from './app/streaming/streamingResponse'
 
 /**
  * Defines a handler for processing and sending activities.
@@ -73,7 +74,7 @@ export class TurnContext {
   private readonly _onDeleteActivity: DeleteActivityHandler[] = []
   private readonly _turn = 'turn'
   private readonly _locale = 'locale'
-
+  private readonly _streamingResponse: StreamingResponse
   /**
    * Initializes a new instance of the TurnContext class.
    *
@@ -89,6 +90,7 @@ export class TurnContext {
       this._adapter = adapterOrContext
       this._activity = request as Activity
     }
+    this._streamingResponse = new StreamingResponse(this)
   }
 
   /**
@@ -395,6 +397,10 @@ export class TurnContext {
     return this._turnState
   }
 
+  get streamingResponse (): StreamingResponse {
+    return this._streamingResponse
+  }
+
   /**
    * Emits events to registered middleware handlers.
    *