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

package/src/oauth/userTokenClient.ts

@@ -2,12 +2,10 @@
 // Licensed under the MIT License.
 
 import axios, { AxiosInstance } from 'axios'
-import { SigningResource } from './signingResource'
 import { ConversationReference } from '@microsoft/agents-activity'
 import { debug } from '../logger'
-import { TokenExchangeRequest } from './tokenExchangeRequest'
 import { normalizeTokenExchangeState } from '../activityWireCompat'
-import { TokenRequestStatus, TokenResponse } from './tokenResponse'
+import { AadResourceUrls, SignInResource, TokenExchangeRequest, TokenOrSinginResourceResponse, TokenResponse, TokenStatus } from './userTokenClient.types'
 import { getProductInfo } from '../getProductInfo'
 
 const logger = debug('agents:user-token-client')
@@ -17,12 +15,14 @@ const logger = debug('agents:user-token-client')
  */
 export class UserTokenClient {
   client: AxiosInstance
-
+  msAppId: string
   /**
    * Creates a new instance of UserTokenClient.
    * @param token The token to use for authentication.
+   * @param msAppId The Microsoft application ID.
    */
-  constructor (token: string) {
+  constructor (token: string, appId: string) {
+    this.msAppId = appId
     const baseURL = 'https://api.botframework.com'
     const axiosInstance = axios.create({
       baseURL,
@@ -47,15 +47,12 @@ export class UserTokenClient {
     try {
       const params = { connectionName, channelId, userId, code }
       const response = await this.client.get('/api/usertoken/GetToken', { params })
-      return { ...response.data, status: TokenRequestStatus.Success }
+      return response.data as TokenResponse
     } catch (error: any) {
       if (error.response?.status !== 404) {
         logger.error(error)
       }
-      return {
-        status: TokenRequestStatus.Failed,
-        token: undefined
-      }
+      return { token: undefined }
     }
   }
 
@@ -81,24 +78,24 @@ export class UserTokenClient {
 
   /**
    * Gets the sign-in resource.
-   * @param appId The application ID.
-   * @param cnxName The connection name.
+   * @param msAppId The application ID.
+   * @param connectionName The connection name.
    * @param activity The activity.
    * @returns A promise that resolves to the signing resource.
    */
-  async getSignInResource (appId: string, cnxName: string, conversationReference: ConversationReference, relatesTo?: ConversationReference) : Promise<SigningResource> {
+  async getSignInResource (msAppId: string, connectionName: string, conversation: ConversationReference, relatesTo?: ConversationReference) : Promise<SignInResource> {
     try {
       const tokenExchangeState = {
-        connectionName: cnxName,
-        conversation: conversationReference,
+        connectionName,
+        conversation,
         relatesTo,
-        msAppId: appId
+        msAppId
       }
       const tokenExchangeStateNormalized = normalizeTokenExchangeState(tokenExchangeState)
       const state = Buffer.from(JSON.stringify(tokenExchangeStateNormalized)).toString('base64')
       const params = { state }
       const response = await this.client.get('/api/botsignin/GetSignInResource', { params })
-      return response.data as SigningResource
+      return response.data as SignInResource
     } catch (error: any) {
       logger.error(error)
       throw error
@@ -117,10 +114,56 @@ export class UserTokenClient {
     try {
       const params = { userId, connectionName, channelId }
       const response = await this.client.post('/api/usertoken/exchange', tokenExchangeRequest, { params })
-      return { ...response.data, status: TokenRequestStatus.Success }
+      return response.data as TokenResponse
     } catch (error: any) {
       logger.error(error)
-      return { status: TokenRequestStatus.Failed, token: undefined }
+      return { token: undefined }
     }
   }
+
+  /**
+   * Gets the token or sign-in resource.
+   * @param userId The user ID.
+   * @param connectionName The connection name.
+   * @param channelId The channel ID.
+   * @param conversation The conversation reference.
+   * @param relatesTo The related conversation reference.
+   * @param code The code.
+   * @param finalRedirect The final redirect URL.
+   * @param fwdUrl The forward URL.
+   * @returns A promise that resolves to the token or sign-in resource response.
+   */
+  async getTokenOrSignInResource (userId: string, connectionName: string, channelId: string, conversation: ConversationReference, relatesTo: ConversationReference, code: string, finalRedirect: string = '', fwdUrl: string = '') : Promise<TokenOrSinginResourceResponse> {
+    const state = Buffer.from(JSON.stringify({ conversation, relatesTo, connectionName, msAppId: this.msAppId })).toString('base64')
+    const params = { userId, connectionName, channelId, state, code, finalRedirect, fwdUrl }
+    const response = await this.client.get('/api/usertoken/GetTokenOrSignInResource', { params })
+    return response.data as TokenOrSinginResourceResponse
+  }
+
+  /**
+   * Gets the token status.
+   * @param userId The user ID.
+   * @param channelId The channel ID.
+   * @param include The optional include parameter.
+   * @returns A promise that resolves to the token status.
+   */
+  async getTokenStatus (userId: string, channelId: string, include: string = null!): Promise<TokenStatus[]> {
+    const params = { userId, channelId, include }
+    const response = await this.client.get('/api/usertoken/GetTokenStatus', { params })
+    return response.data as TokenStatus[]
+  }
+
+  /**
+   * Gets the AAD tokens.
+   * @param userId The user ID.
+   * @param connectionName The connection name.
+   * @param channelId The channel ID.
+   * @param resourceUrls The resource URLs.
+   * @returns A promise that resolves to the AAD tokens.
+   */
+  async getAadTokens (userId: string, connectionName: string, channelId: string, resourceUrls: AadResourceUrls) : Promise<Record<string, TokenResponse>> {
+    const params = { userId, connectionName, channelId }
+    const response = await this.client.post('/api/usertoken/GetAadTokens', resourceUrls, { params })
+    return response.data as Record<string, TokenResponse>
+  }
 }

package/src/oauth/userTokenClient.types.ts

@@ -0,0 +1,173 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { CardAction } from '@microsoft/agents-activity'
+
+/**
+ * Represents the response containing OAuth token information.
+ * This interface encapsulates all data related to an OAuth token response.
+ */
+export interface TokenResponse {
+  /**
+     * The OAuth token string, or undefined if no token is available.
+     */
+  token: string | undefined;
+}
+
+/**
+ * Represents a request for exchanging tokens.
+ * This interface defines the structure of a token exchange request, including the URI, token, and ID.
+ */
+export interface TokenExchangeRequest {
+  /**
+     * The URI for the token exchange request.
+     */
+  uri?: string;
+
+  /**
+     * The token to be exchanged.
+     */
+  token?: string;
+
+  /**
+     * The ID associated with the token exchange request.
+     */
+  id?: string;
+}
+
+/**
+ * Represents a resource for exchanging tokens.
+ * This interface defines the structure of a token exchange resource, including its ID, URI, and provider ID.
+ */
+export interface TokenExchangeResource {
+  /**
+     * The ID of the token exchange resource.
+     */
+  id?: string;
+
+  /**
+     * The URI of the token exchange resource.
+     */
+  uri?: string;
+
+  /**
+     * The provider ID for the token exchange resource.
+     */
+  providerId?: string;
+}
+
+/**
+ * Represents a resource for posting tokens.
+ * This interface defines the structure of a token post resource, including its SAS URL.
+ */
+export interface TokenPostResource {
+  /**
+     * The SAS URL for the token post resource.
+     */
+  sasUrl?: string;
+}
+
+/**
+ * Represents a resource for signing in.
+ * This interface defines the structure of a sign-in resource, including the sign-in link, token exchange resource, and token post resource.
+ */
+export interface SignInResource {
+  /**
+     * The link for signing in.
+     */
+  signInLink: string;
+
+  /**
+     * The resource for token exchange.
+     */
+  tokenExchangeResource: TokenExchangeResource;
+
+  /**
+     * The resource for token post.
+     */
+  tokenPostResource: TokenPostResource;
+}
+
+/**
+ * Represents an OAuth card.
+ * This interface defines the structure of an OAuth card, including its buttons, connection name, text, and associated resources.
+ */
+export interface OAuthCard {
+  /**
+     * The buttons associated with the OAuth card.
+     */
+  buttons: CardAction[];
+
+  /**
+     * The connection name for the OAuth card.
+     */
+  connectionName: string;
+
+  /**
+     * The text content of the OAuth card.
+     */
+  text: string;
+
+  /**
+     * The token exchange resource for the OAuth card.
+     */
+  tokenExchangeResource: TokenExchangeResource;
+
+  /**
+     * The token post resource for the OAuth card.
+     */
+  tokenPostResource: TokenPostResource;
+}
+
+/**
+ * Represents a response containing either a token or a sign-in resource.
+ * This interface defines the structure of a response that includes a token response and a sign-in resource.
+ */
+export interface TokenOrSinginResourceResponse {
+  /**
+     * The token response containing OAuth token information.
+     */
+  tokenResponse: TokenResponse;
+
+  /**
+     * The sign-in resource containing sign-in and token exchange information.
+     */
+  signInResource: SignInResource;
+}
+
+/**
+ * Represents the status of a token.
+ * This interface defines the structure of a token status, including channel ID, connection name, and other metadata.
+ */
+export interface TokenStatus {
+  /**
+     * The ID of the channel associated with the token.
+     */
+  channelId: string;
+
+  /**
+     * The connection name associated with the token.
+     */
+  connectionName: string;
+
+  /**
+     * Indicates whether a token is available.
+     */
+  hasToken: boolean;
+
+  /**
+     * The display name of the service provider.
+     */
+  serviceProviderDisplayName: string;
+}
+
+/**
+ * Represents a collection of Azure Active Directory (AAD) resource URLs.
+ * This interface defines the structure of a collection of resource URLs.
+ */
+export interface AadResourceUrls {
+  /**
+     * An array of resource URLs.
+     */
+  resourceUrls: string[];
+}

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.
    *

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

@@ -1,27 +0,0 @@
-import { CardAction } from '@microsoft/agents-activity';
-import { TokenExchangeResource, TokenPostResource } from './signingResource';
-/**
- * Represents an OAuth card.
- */
-export interface OAuthCard {
-    /**
-     * The buttons associated with the OAuth card.
-     */
-    buttons: CardAction[];
-    /**
-     * The connection name for the OAuth card.
-     */
-    connectionName: string;
-    /**
-     * The text content of the OAuth card.
-     */
-    text: string;
-    /**
-     * The token exchange resource for the OAuth card.
-     */
-    tokenExchangeResource: TokenExchangeResource;
-    /**
-     * The token post resource for the OAuth card.
-     */
-    tokenPostResource: TokenPostResource;
-}

package/dist/src/oauth/oAuthCard.js

@@ -1,5 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=oAuthCard.js.map

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

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

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

@@ -1,43 +0,0 @@
-/**
- * Represents a resource for exchanging tokens.
- */
-export interface TokenExchangeResource {
-    /**
-     * The ID of the token exchange resource.
-     */
-    id?: string;
-    /**
-     * The URI of the token exchange resource.
-     */
-    uri?: string;
-    /**
-     * The provider ID for the token exchange resource.
-     */
-    providerId?: string;
-}
-/**
- * Represents a resource for posting tokens.
- */
-export interface TokenPostResource {
-    /**
-     * The SAS URL for the token post resource.
-     */
-    sasUrl?: string;
-}
-/**
- * Represents a resource for signing in.
- */
-export interface SigningResource {
-    /**
-     * The link for signing in.
-     */
-    signInLink: string;
-    /**
-     * The resource for token exchange.
-     */
-    tokenExchangeResource: TokenExchangeResource;
-    /**
-     * The resource for token post.
-     */
-    tokenPostResource: TokenPostResource;
-}

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

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

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

@@ -1,17 +0,0 @@
-/**
- * Represents a request for exchanging tokens.
- */
-export interface TokenExchangeRequest {
-    /**
-     * The URI for the token exchange request.
-     */
-    uri?: string;
-    /**
-     * The token to be exchanged.
-     */
-    token?: string;
-    /**
-     * The ID associated with the token exchange request.
-     */
-    id?: string;
-}

package/dist/src/oauth/tokenExchangeRequest.js

@@ -1,5 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=tokenExchangeRequest.js.map

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

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

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

@@ -1,29 +0,0 @@
-/**
- * Represents the status of an OAuth token request.
- */
-export declare enum TokenRequestStatus {
-    /**
-     * Indicates that the token request was successful.
-     */
-    Success = "Success",
-    /**
-     * Indicates that the token request failed.
-     */
-    Failed = "Failed",
-    /**
-     * Indicates that the token request is pending.
-     */
-    InProgress = "InProgress",
-    Expired = "Expired"
-}
-/**
- * Represents the response containing OAuth token information.
- * This interface encapsulates all data related to an OAuth token response.
- */
-export interface TokenResponse {
-    status: TokenRequestStatus;
-    /**
-     * The OAuth token string, or null if no token is available.
-     */
-    token: string | undefined;
-}

package/dist/src/oauth/tokenResponse.js

@@ -1,25 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenRequestStatus = void 0;
-/**
- * Represents the status of an OAuth token request.
- */
-var TokenRequestStatus;
-(function (TokenRequestStatus) {
-    /**
-     * Indicates that the token request was successful.
-     */
-    TokenRequestStatus["Success"] = "Success";
-    /**
-     * Indicates that the token request failed.
-     */
-    TokenRequestStatus["Failed"] = "Failed";
-    /**
-     * Indicates that the token request is pending.
-     */
-    TokenRequestStatus["InProgress"] = "InProgress";
-    TokenRequestStatus["Expired"] = "Expired";
-})(TokenRequestStatus || (exports.TokenRequestStatus = TokenRequestStatus = {}));
-//# sourceMappingURL=tokenResponse.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"tokenResponse.js","sourceRoot":"","sources":["../../../src/oauth/tokenResponse.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAC5D,kCAAkC;;;AAElC;;GAEG;AACH,IAAY,kBAiBX;AAjBD,WAAY,kBAAkB;IAC5B;;OAEG;IACH,yCAAmB,CAAA;IAEnB;;OAEG;IACH,uCAAiB,CAAA;IAEjB;;OAEG;IACH,+CAAyB,CAAA;IAEzB,yCAAmB,CAAA;AACrB,CAAC,EAjBW,kBAAkB,kCAAlB,kBAAkB,QAiB7B"}

package/src/oauth/oAuthCard.ts

@@ -1,30 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { CardAction } from '@microsoft/agents-activity'
-import { TokenExchangeResource, TokenPostResource } from './signingResource'
-/**
- * Represents an OAuth card.
- */
-export interface OAuthCard {
-  /**
-   * The buttons associated with the OAuth card.
-   */
-  buttons: CardAction[]
-  /**
-   * The connection name for the OAuth card.
-   */
-  connectionName: string
-  /**
-   * The text content of the OAuth card.
-   */
-  text: string
-  /**
-   * The token exchange resource for the OAuth card.
-   */
-  tokenExchangeResource: TokenExchangeResource
-  /**
-   * The token post resource for the OAuth card.
-   */
-  tokenPostResource: TokenPostResource
-}

package/src/oauth/signingResource.ts

@@ -1,48 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * Represents a resource for exchanging tokens.
- */
-export interface TokenExchangeResource {
-  /**
-   * The ID of the token exchange resource.
-   */
-  id?: string
-  /**
-   * The URI of the token exchange resource.
-   */
-  uri?: string
-  /**
-   * The provider ID for the token exchange resource.
-   */
-  providerId?: string
-}
-
-/**
- * Represents a resource for posting tokens.
- */
-export interface TokenPostResource {
-  /**
-   * The SAS URL for the token post resource.
-   */
-  sasUrl?: string
-}
-
-/**
- * Represents a resource for signing in.
- */
-export interface SigningResource {
-  /**
-   * The link for signing in.
-   */
-  signInLink: string,
-  /**
-   * The resource for token exchange.
-   */
-  tokenExchangeResource: TokenExchangeResource,
-  /**
-   * The resource for token post.
-   */
-  tokenPostResource: TokenPostResource
-}

package/src/oauth/tokenExchangeRequest.ts

@@ -1,20 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * Represents a request for exchanging tokens.
- */
-export interface TokenExchangeRequest {
-  /**
-   * The URI for the token exchange request.
-   */
-  uri?: string
-  /**
-   * The token to be exchanged.
-   */
-  token?: string
-  /**
-   * The ID associated with the token exchange request.
-   */
-  id?: string
-}

package/src/oauth/tokenResponse.ts

@@ -1,43 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * Represents the status of an OAuth token request.
- */
-export enum TokenRequestStatus {
-  /**
-   * Indicates that the token request was successful.
-   */
-  Success = 'Success',
-
-  /**
-   * Indicates that the token request failed.
-   */
-  Failed = 'Failed',
-
-  /**
-   * Indicates that the token request is pending.
-   */
-  InProgress = 'InProgress',
-
-  Expired = 'Expired',
-}
-
-/**
- * Represents the response containing OAuth token information.
- * This interface encapsulates all data related to an OAuth token response.
- */
-export interface TokenResponse {
-
-  status: TokenRequestStatus
-
-  /**
-   * The OAuth token string, or null if no token is available.
-   */
-  token: string | undefined
-
-  /**
-   * The expiration time of the token, represented as a numeric timestamp.
-   */
-  // expires: number
-}