@microsoft/teamsfx 4.0.1-alpha.f4d8f5081.0 → 4.0.1-beta.2025072307.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -53
- package/dist/index.esm2017.js.map +1 -1
- package/dist/index.esm2017.mjs +2 -2
- package/dist/index.esm2017.mjs.map +1 -1
- package/dist/index.esm5.js.map +1 -1
- package/dist/index.node.cjs.js +2 -2
- package/dist/index.node.cjs.js.map +1 -1
- package/dist/types/teamsfx.d.ts +155 -7
- package/package.json +7 -7
package/dist/types/teamsfx.d.ts
CHANGED
@@ -9,7 +9,7 @@ import { AxiosInstance } from 'axios';
|
|
9
9
|
import { AxiosRequestConfig } from 'axios';
|
10
10
|
import { CardAction } from '@microsoft/agents-activity';
|
11
11
|
import { CardImage } from '@microsoft/agents-hosting';
|
12
|
-
import { ChannelInfo } from '@microsoft/agents-hosting-teams';
|
12
|
+
import { ChannelInfo } from '@microsoft/agents-hosting-extensions-teams';
|
13
13
|
import { CloudAdapter } from '@microsoft/agents-hosting';
|
14
14
|
import { ComponentDialog } from '@microsoft/agents-hosting-dialogs';
|
15
15
|
import { ConversationReference } from '@microsoft/agents-activity';
|
@@ -20,16 +20,15 @@ import { DialogTurnResult } from '@microsoft/agents-hosting-dialogs';
|
|
20
20
|
import { GetTokenOptions } from '@azure/identity';
|
21
21
|
import { HeroCard } from '@microsoft/agents-hosting';
|
22
22
|
import { InvokeResponse } from '@microsoft/agents-hosting';
|
23
|
-
import { MessagingExtensionResponse } from '@microsoft/agents-hosting-teams';
|
23
|
+
import { MessagingExtensionResponse } from '@microsoft/agents-hosting-extensions-teams';
|
24
24
|
import { O365ConnectorCard } from '@microsoft/agents-hosting';
|
25
25
|
import { ReceiptCard } from '@microsoft/agents-hosting';
|
26
26
|
import { Request as Request_2 } from '@microsoft/agents-hosting';
|
27
27
|
import { SecureContextOptions } from 'tls';
|
28
|
-
import { SigninStateVerificationQuery } from '@microsoft/agents-hosting-teams';
|
29
28
|
import { StatusCodes } from '@microsoft/agents-hosting';
|
30
29
|
import { Storage as Storage_2 } from '@microsoft/agents-hosting';
|
31
|
-
import { TeamDetails } from '@microsoft/agents-hosting-teams';
|
32
|
-
import { TeamsChannelAccount } from '@microsoft/agents-hosting-teams';
|
30
|
+
import { TeamDetails } from '@microsoft/agents-hosting-extensions-teams';
|
31
|
+
import { TeamsChannelAccount } from '@microsoft/agents-hosting-extensions-teams';
|
33
32
|
import { ThumbnailCard } from '@microsoft/agents-hosting';
|
34
33
|
import { TokenCredential } from '@azure/identity';
|
35
34
|
import { TurnContext } from '@microsoft/agents-hosting';
|
@@ -37,6 +36,7 @@ import { UserState } from '@microsoft/agents-hosting';
|
|
37
36
|
|
38
37
|
/**
|
39
38
|
* Options used to control how the response card will be sent to users.
|
39
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
40
40
|
*/
|
41
41
|
export declare enum AdaptiveCardResponse {
|
42
42
|
/**
|
@@ -74,6 +74,7 @@ export { AgentBuilderCloudAdapter }
|
|
74
74
|
|
75
75
|
/**
|
76
76
|
* Define available location for API Key location
|
77
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
77
78
|
*/
|
78
79
|
export declare enum ApiKeyLocation {
|
79
80
|
/**
|
@@ -88,6 +89,7 @@ export declare enum ApiKeyLocation {
|
|
88
89
|
|
89
90
|
/**
|
90
91
|
* Provider that handles API Key authentication
|
92
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
91
93
|
*/
|
92
94
|
export declare class ApiKeyProvider implements AuthProvider {
|
93
95
|
private keyName;
|
@@ -101,6 +103,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
101
103
|
*
|
102
104
|
* @throws {@link ErrorCode|InvalidParameter} - when key name or key value is empty.
|
103
105
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
106
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
104
107
|
*/
|
105
108
|
constructor(keyName: string, keyValue: string, keyLocation: ApiKeyLocation);
|
106
109
|
/**
|
@@ -113,6 +116,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
113
116
|
*
|
114
117
|
* @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when API key already exists in request header or url query parameter.
|
115
118
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
119
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
116
120
|
*/
|
117
121
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
118
122
|
}
|
@@ -120,6 +124,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
120
124
|
/**
|
121
125
|
* Represent Microsoft 365 tenant identity, and it is usually used when user is not involved like time-triggered automation job.
|
122
126
|
*
|
127
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
128
|
+
*
|
123
129
|
* @example
|
124
130
|
* ```typescript
|
125
131
|
* loadConfiguration(); // load configuration from environment variables
|
@@ -134,6 +140,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
134
140
|
/**
|
135
141
|
* Constructor of AppCredential.
|
136
142
|
*
|
143
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
144
|
+
*
|
137
145
|
* @remarks
|
138
146
|
* Only works in in server side.
|
139
147
|
*
|
@@ -146,6 +154,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
146
154
|
/**
|
147
155
|
* Get access token for credential.
|
148
156
|
*
|
157
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
158
|
+
*
|
149
159
|
* @example
|
150
160
|
* ```typescript
|
151
161
|
* await credential.getToken(["User.Read.All"]) // Get Graph access token for single scope using string array
|
@@ -180,11 +190,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
180
190
|
|
181
191
|
/**
|
182
192
|
* Authentication configuration for AppCredential used in node environment
|
193
|
+
*
|
194
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
183
195
|
*/
|
184
196
|
export declare type AppCredentialAuthConfig = OnBehalfOfCredentialAuthConfig;
|
185
197
|
|
186
198
|
/**
|
187
199
|
* Defines method that injects authentication info to http requests
|
200
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
188
201
|
*/
|
189
202
|
export declare interface AuthProvider {
|
190
203
|
/**
|
@@ -192,6 +205,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
192
205
|
*
|
193
206
|
* @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
|
194
207
|
* Refer https://axios-http.com/docs/req_config for detailed document.
|
208
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
195
209
|
*/
|
196
210
|
AddAuthenticationInfo: (config: AxiosRequestConfig) => Promise<AxiosRequestConfig>;
|
197
211
|
}
|
@@ -200,6 +214,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
200
214
|
|
201
215
|
/**
|
202
216
|
* Provider that handles Basic authentication
|
217
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
203
218
|
*/
|
204
219
|
export declare class BasicAuthProvider implements AuthProvider {
|
205
220
|
private userName;
|
@@ -211,6 +226,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
211
226
|
*
|
212
227
|
* @throws {@link ErrorCode|InvalidParameter} - when username or password is empty.
|
213
228
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
229
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
214
230
|
*/
|
215
231
|
constructor(userName: string, password: string);
|
216
232
|
/**
|
@@ -223,17 +239,20 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
223
239
|
*
|
224
240
|
* @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header or auth property already exists in request configuration.
|
225
241
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
242
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
226
243
|
*/
|
227
244
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
228
245
|
}
|
229
246
|
|
230
247
|
/**
|
231
248
|
* Provider that handles Bearer Token authentication
|
249
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
232
250
|
*/
|
233
251
|
export declare class BearerTokenAuthProvider implements AuthProvider {
|
234
252
|
private getToken;
|
235
253
|
/**
|
236
254
|
* @param { () => Promise<string> } getToken - Function that returns the content of bearer token used in http request
|
255
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
237
256
|
*/
|
238
257
|
constructor(getToken: () => Promise<string>);
|
239
258
|
/**
|
@@ -245,12 +264,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
245
264
|
* @returns Updated axios request config.
|
246
265
|
*
|
247
266
|
* @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header already exists in request configuration.
|
267
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
248
268
|
*/
|
249
269
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
250
270
|
}
|
251
271
|
|
252
272
|
/**
|
253
273
|
* Interface for SSO configuration for Bot SSO
|
274
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
254
275
|
*/
|
255
276
|
export declare interface BotSsoConfig {
|
256
277
|
/**
|
@@ -321,6 +342,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
321
342
|
* });
|
322
343
|
* ```
|
323
344
|
* For details information about how to implement a BotSsoExecutionActivityHandler, please refer DefaultBotSsoExecutionActivityHandler class source code: https://aka.ms/teamsfx-default-sso-execution-activity-handler
|
345
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
324
346
|
*/
|
325
347
|
export declare interface BotSsoExecutionActivityHandler {
|
326
348
|
/**
|
@@ -346,7 +368,9 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
346
368
|
* @remarks
|
347
369
|
* It should trigger {@link BotSsoExecutionDialog} instance to handle signin process
|
348
370
|
*/
|
349
|
-
handleTeamsSigninVerifyState(context: TurnContext, query:
|
371
|
+
handleTeamsSigninVerifyState(context: TurnContext, query: {
|
372
|
+
state?: string;
|
373
|
+
}): Promise<void>;
|
350
374
|
/**
|
351
375
|
* Receives invoke activities with Activity name of 'signin/tokenExchange'
|
352
376
|
* @param context A context object for this turn.
|
@@ -356,11 +380,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
356
380
|
* @remarks
|
357
381
|
* It should trigger {@link BotSsoExecutionDialog} instance to handle signin process
|
358
382
|
*/
|
359
|
-
handleTeamsSigninTokenExchange(context: TurnContext, query:
|
383
|
+
handleTeamsSigninTokenExchange(context: TurnContext, query: {
|
384
|
+
state?: string;
|
385
|
+
}): Promise<void>;
|
360
386
|
}
|
361
387
|
|
362
388
|
/**
|
363
389
|
* Sso execution dialog, use to handle sso command
|
390
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
364
391
|
*/
|
365
392
|
export declare class BotSsoExecutionDialog extends ComponentDialog {
|
366
393
|
private dedupStorage;
|
@@ -373,12 +400,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
373
400
|
* @param {@link OnBehalfOfCredentialAuthConfig} authConfig The authentication configuration.
|
374
401
|
* @param {string} initiateLoginEndpoint Login URL for Teams to redirect to.
|
375
402
|
* @param {string} dialogName custom dialog name
|
403
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
376
404
|
*/
|
377
405
|
constructor(dedupStorage: Storage_2, ssoPromptSettings: TeamsBotSsoPromptSettings, authConfig: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, dialogName?: string);
|
378
406
|
/**
|
379
407
|
* Add TeamsFxBotSsoCommandHandler instance
|
380
408
|
* @param handler {@link BotSsoExecutionDialogHandler} callback function
|
381
409
|
* @param triggerPatterns The trigger pattern
|
410
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
382
411
|
*/
|
383
412
|
addCommand(handler: BotSsoExecutionDialogHandler, triggerPatterns: TriggerPatterns): void;
|
384
413
|
private getCommandHash;
|
@@ -387,6 +416,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
387
416
|
*
|
388
417
|
* @param context The context object for the current turn.
|
389
418
|
* @param accessor The instance of StatePropertyAccessor for dialog system.
|
419
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
390
420
|
*/
|
391
421
|
run(context: TurnContext, accessor: AgentStatePropertyAccessor): Promise<void>;
|
392
422
|
private getActivityText;
|
@@ -421,10 +451,15 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
421
451
|
private ensureMsTeamsChannel;
|
422
452
|
}
|
423
453
|
|
454
|
+
/**
|
455
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
456
|
+
*/
|
424
457
|
export declare type BotSsoExecutionDialogHandler = (context: TurnContext, tokenResponse: TeamsBotSsoPromptTokenResponse, message: CommandMessage) => Promise<void>;
|
425
458
|
|
426
459
|
/**
|
427
460
|
* A card action bot to respond to adaptive card universal actions.
|
461
|
+
*
|
462
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
428
463
|
*/
|
429
464
|
declare class CardActionBot {
|
430
465
|
private readonly adapter;
|
@@ -432,6 +467,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
432
467
|
/**
|
433
468
|
* Create a new instance of the `CardActionBot`.
|
434
469
|
*
|
470
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
435
471
|
* @param adapter - The bound `CloudAdapter`.
|
436
472
|
* @param options - The initialize options.
|
437
473
|
*/
|
@@ -439,12 +475,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
439
475
|
/**
|
440
476
|
* Register a card action handler to the bot.
|
441
477
|
*
|
478
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
442
479
|
* @param actionHandler - A card action handler to be registered.
|
443
480
|
*/
|
444
481
|
registerHandler(actionHandler: TeamsFxAdaptiveCardActionHandler): void;
|
445
482
|
/**
|
446
483
|
* Register card action handlers to the bot.
|
447
484
|
*
|
485
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
448
486
|
* @param actionHandlers - A set of card action handlers to be registered.
|
449
487
|
*/
|
450
488
|
registerHandlers(actionHandlers: TeamsFxAdaptiveCardActionHandler[]): void;
|
@@ -452,6 +490,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
452
490
|
|
453
491
|
/**
|
454
492
|
* Options to initialize {@link CardActionBot}.
|
493
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
455
494
|
*/
|
456
495
|
export declare interface CardActionOptions {
|
457
496
|
/**
|
@@ -462,6 +501,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
462
501
|
|
463
502
|
/**
|
464
503
|
* Provider that handles Certificate authentication
|
504
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
465
505
|
*/
|
466
506
|
export declare class CertificateAuthProvider implements AuthProvider {
|
467
507
|
private certOption;
|
@@ -470,6 +510,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
470
510
|
* @param { SecureContextOptions } certOption - information about the cert used in http requests
|
471
511
|
*
|
472
512
|
* @throws {@link ErrorCode|InvalidParameter} - when cert option is empty.
|
513
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
473
514
|
*/
|
474
515
|
constructor(certOption: SecureContextOptions);
|
475
516
|
/**
|
@@ -481,6 +522,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
481
522
|
* @returns Updated axios request config.
|
482
523
|
*
|
483
524
|
* @throws {@link ErrorCode|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
|
525
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
484
526
|
*/
|
485
527
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
486
528
|
}
|
@@ -488,6 +530,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
488
530
|
/**
|
489
531
|
* A {@link NotificationTarget} that represents a team channel.
|
490
532
|
*
|
533
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
491
534
|
* @remarks
|
492
535
|
* It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
|
493
536
|
*/
|
@@ -507,6 +550,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
507
550
|
/**
|
508
551
|
* Constructor.
|
509
552
|
*
|
553
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
510
554
|
* @remarks
|
511
555
|
* It's recommended to get channels from {@link TeamsBotInstallation.channels()}, instead of using this constructor.
|
512
556
|
*
|
@@ -517,6 +561,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
517
561
|
/**
|
518
562
|
* Send a plain text message.
|
519
563
|
*
|
564
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
520
565
|
* @param text - The plain text message.
|
521
566
|
* @param onError - An optional error handler that can catch exceptions during message sending.
|
522
567
|
* If not defined, error will be handled by `BotAdapter.onTurnError`.
|
@@ -527,6 +572,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
527
572
|
/**
|
528
573
|
* Send an adaptive card message.
|
529
574
|
*
|
575
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
530
576
|
* @param card - The adaptive card raw JSON.
|
531
577
|
* @param onError - An optional error handler that can catch exceptions during adaptive card sending.
|
532
578
|
* If not defined, error will be handled by `BotAdapter.onTurnError`.
|
@@ -543,6 +589,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
543
589
|
/**
|
544
590
|
* A command bot for receiving commands and sending responses in Teams.
|
545
591
|
*
|
592
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
546
593
|
* @remarks
|
547
594
|
* Ensure each command should ONLY be registered with the command once, otherwise it'll cause unexpected behavior if you register the same command more than once.
|
548
595
|
*/
|
@@ -553,6 +600,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
553
600
|
/**
|
554
601
|
* Create a new instance of the `CommandBot`.
|
555
602
|
*
|
603
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
556
604
|
* @param adapter - The bound `CloudAdapter`.
|
557
605
|
* @param options - The initialize options
|
558
606
|
* @param ssoCommandActivityHandler - SSO execution activity handler.
|
@@ -562,24 +610,28 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
562
610
|
/**
|
563
611
|
* Register a command into the command bot.
|
564
612
|
*
|
613
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
565
614
|
* @param command - The command to be registered.
|
566
615
|
*/
|
567
616
|
registerCommand(command: TeamsFxBotCommandHandler): void;
|
568
617
|
/**
|
569
618
|
* Register commands into the command bot.
|
570
619
|
*
|
620
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
571
621
|
* @param commands - The commands to be registered.
|
572
622
|
*/
|
573
623
|
registerCommands(commands: TeamsFxBotCommandHandler[]): void;
|
574
624
|
/**
|
575
625
|
* Register a sso command into the command bot.
|
576
626
|
*
|
627
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
577
628
|
* @param ssoCommand - The sso command to be registered.
|
578
629
|
*/
|
579
630
|
registerSsoCommand(ssoCommand: TeamsFxBotSsoCommandHandler): void;
|
580
631
|
/**
|
581
632
|
* Register sso commands into the command bot.
|
582
633
|
*
|
634
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
583
635
|
* @param ssoCommands - The sso commands to be registered.
|
584
636
|
*/
|
585
637
|
registerSsoCommands(ssoCommands: TeamsFxBotSsoCommandHandler[]): void;
|
@@ -588,6 +640,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
588
640
|
|
589
641
|
/**
|
590
642
|
* Interface for a command message that can handled in a command handler.
|
643
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
591
644
|
*/
|
592
645
|
export declare interface CommandMessage {
|
593
646
|
/**
|
@@ -602,6 +655,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
602
655
|
|
603
656
|
/**
|
604
657
|
* Options to initialize {@link CommandBot}.
|
658
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
605
659
|
*/
|
606
660
|
export declare interface CommandOptions {
|
607
661
|
/**
|
@@ -619,6 +673,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
619
673
|
* - handle command and response.
|
620
674
|
* - send notification to varies targets (e.g., member, group, channel).
|
621
675
|
*
|
676
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
622
677
|
* @example
|
623
678
|
* For command and response, you can register your commands through the constructor, or use the `registerCommand` and `registerCommands` API to add commands later.
|
624
679
|
*
|
@@ -691,6 +746,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
691
746
|
/**
|
692
747
|
* Create new instance of the `ConversationBot`.
|
693
748
|
*
|
749
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
694
750
|
* @remarks
|
695
751
|
* It's recommended to create your own adapter and storage for production environment instead of the default one.
|
696
752
|
*
|
@@ -701,6 +757,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
701
757
|
/**
|
702
758
|
* The request handler to integrate with web request.
|
703
759
|
*
|
760
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
704
761
|
* @param req - An incoming HTTP [Request](xref:botbuilder.Request).
|
705
762
|
* @param res - The corresponding HTTP [Response](xref:botbuilder.Response).
|
706
763
|
* @param logic - The additional function to handle bot context.
|
@@ -728,6 +785,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
728
785
|
|
729
786
|
/**
|
730
787
|
* Options to initialize {@link ConversationBot}
|
788
|
+
*
|
789
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
731
790
|
*/
|
732
791
|
declare interface ConversationOptions {
|
733
792
|
/**
|
@@ -781,6 +840,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
781
840
|
|
782
841
|
/**
|
783
842
|
* A store to persist notification target references.
|
843
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
784
844
|
*/
|
785
845
|
export declare interface ConversationReferenceStore {
|
786
846
|
/**
|
@@ -815,6 +875,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
815
875
|
|
816
876
|
/**
|
817
877
|
* Options to add a conversation reference to the store.
|
878
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
818
879
|
*/
|
819
880
|
export declare interface ConversationReferenceStoreAddOptions {
|
820
881
|
/**
|
@@ -834,6 +895,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
834
895
|
* ```typescript
|
835
896
|
* const client = createApiClient("https://my-api-endpoint-base-url", new BasicAuthProvider("xxx","xxx"));
|
836
897
|
* ```
|
898
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
837
899
|
*/
|
838
900
|
export declare function createApiClient(apiEndpoint: string, authProvider: AuthProvider): AxiosInstance;
|
839
901
|
|
@@ -847,6 +909,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
847
909
|
* @returns Instance of SecureContextOptions
|
848
910
|
*
|
849
911
|
* @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
|
912
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
850
913
|
*
|
851
914
|
*/
|
852
915
|
export declare function createPemCertOption(cert: string | Buffer, key: string | Buffer, options?: {
|
@@ -863,6 +926,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
863
926
|
* @returns Instance of SecureContextOptions
|
864
927
|
*
|
865
928
|
* @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
|
929
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
866
930
|
*
|
867
931
|
*/
|
868
932
|
export declare function createPfxCertOption(pfx: string | Buffer, options?: {
|
@@ -871,6 +935,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
871
935
|
|
872
936
|
/**
|
873
937
|
* Error code to trace the error types.
|
938
|
+
*
|
939
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
874
940
|
*/
|
875
941
|
export declare enum ErrorCode {
|
876
942
|
/**
|
@@ -953,6 +1019,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
953
1019
|
|
954
1020
|
/**
|
955
1021
|
* Error class with code and message thrown by the SDK.
|
1022
|
+
*
|
1023
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
956
1024
|
*/
|
957
1025
|
export declare class ErrorWithCode extends Error {
|
958
1026
|
/**
|
@@ -964,6 +1032,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
964
1032
|
/**
|
965
1033
|
* Constructor of ErrorWithCode.
|
966
1034
|
*
|
1035
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
967
1036
|
* @param {string} message - error message.
|
968
1037
|
* @param {ErrorCode} code - error code.
|
969
1038
|
*/
|
@@ -973,10 +1042,15 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
973
1042
|
/**
|
974
1043
|
* Get log level.
|
975
1044
|
*
|
1045
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1046
|
+
*
|
976
1047
|
* @returns Log level
|
977
1048
|
*/
|
978
1049
|
export declare function getLogLevel(): LogLevel | undefined;
|
979
1050
|
|
1051
|
+
/**
|
1052
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1053
|
+
*/
|
980
1054
|
export declare interface GetTeamsUserTokenOptions extends GetTokenOptions {
|
981
1055
|
resources?: string[];
|
982
1056
|
}
|
@@ -984,6 +1058,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
984
1058
|
/**
|
985
1059
|
* Users execute link query in message extension with SSO or access token.
|
986
1060
|
*
|
1061
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1062
|
+
*
|
987
1063
|
* @param {TurnContext} context - The context object for the current turn.
|
988
1064
|
* @param {OnBehalfOfCredentialAuthConfig} config - User custom the message extension authentication configuration.
|
989
1065
|
* @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
|
@@ -1004,6 +1080,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1004
1080
|
/**
|
1005
1081
|
* Users execute query in message extension with SSO or access token.
|
1006
1082
|
*
|
1083
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1084
|
+
*
|
1007
1085
|
* @param {TurnContext} context - The context object for the current turn.
|
1008
1086
|
* @param {OnBehalfOfCredentialAuthConfig} config - User custom the message extension authentication configuration.
|
1009
1087
|
* @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
|
@@ -1023,6 +1101,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1023
1101
|
|
1024
1102
|
/**
|
1025
1103
|
* Status code for an `application/vnd.microsoft.error` invoke response.
|
1104
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1026
1105
|
*/
|
1027
1106
|
export declare enum InvokeResponseErrorCode {
|
1028
1107
|
/**
|
@@ -1063,6 +1142,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1063
1142
|
* value: invokeResponse,
|
1064
1143
|
* });
|
1065
1144
|
* ```
|
1145
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1066
1146
|
*/
|
1067
1147
|
export declare class InvokeResponseFactory {
|
1068
1148
|
/**
|
@@ -1073,6 +1153,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1073
1153
|
* @param message - A text message included in a invoke response.
|
1074
1154
|
*
|
1075
1155
|
* @returns An `InvokeResponse` object.
|
1156
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1076
1157
|
*/
|
1077
1158
|
static textMessage(message: string): InvokeResponse;
|
1078
1159
|
/**
|
@@ -1085,6 +1166,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1085
1166
|
* @param card - The adaptive card JSON payload.
|
1086
1167
|
*
|
1087
1168
|
* @returns An `InvokeResponse` object.
|
1169
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1088
1170
|
*/
|
1089
1171
|
static adaptiveCard(card: unknown): InvokeResponse;
|
1090
1172
|
/**
|
@@ -1099,6 +1181,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1099
1181
|
* @param errorMessage - The error message.
|
1100
1182
|
*
|
1101
1183
|
* @returns An `InvokeResponse` object.
|
1184
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1102
1185
|
*/
|
1103
1186
|
static errorResponse(errorCode: InvokeResponseErrorCode, errorMessage: string): InvokeResponse;
|
1104
1187
|
/**
|
@@ -1107,17 +1190,22 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1107
1190
|
* @param body - The value of the response body.
|
1108
1191
|
*
|
1109
1192
|
* @returns An `InvokeResponse` object.
|
1193
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1110
1194
|
*/
|
1111
1195
|
static createInvokeResponse(statusCode: StatusCodes, body?: unknown): InvokeResponse;
|
1112
1196
|
}
|
1113
1197
|
|
1114
1198
|
/**
|
1115
1199
|
* Log function for customized logging.
|
1200
|
+
*
|
1201
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1116
1202
|
*/
|
1117
1203
|
export declare type LogFunction = (level: LogLevel, message: string) => void;
|
1118
1204
|
|
1119
1205
|
/**
|
1120
1206
|
* Interface for customized logger.
|
1207
|
+
*
|
1208
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1121
1209
|
*/
|
1122
1210
|
export declare interface Logger {
|
1123
1211
|
/**
|
@@ -1140,6 +1228,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1140
1228
|
|
1141
1229
|
/**
|
1142
1230
|
* Log level.
|
1231
|
+
*
|
1232
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1143
1233
|
*/
|
1144
1234
|
export declare enum LogLevel {
|
1145
1235
|
/**
|
@@ -1163,6 +1253,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1163
1253
|
/**
|
1164
1254
|
* A {@link NotificationTarget} that represents a team member.
|
1165
1255
|
*
|
1256
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1166
1257
|
* @remarks
|
1167
1258
|
* It's recommended to get members from {@link TeamsBotInstallation.members()}.
|
1168
1259
|
*/
|
@@ -1182,6 +1273,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1182
1273
|
/**
|
1183
1274
|
* Constructor.
|
1184
1275
|
*
|
1276
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1185
1277
|
* @remarks
|
1186
1278
|
* It's recommended to get members from {@link TeamsBotInstallation.members()}, instead of using this constructor.
|
1187
1279
|
*
|
@@ -1217,6 +1309,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1217
1309
|
|
1218
1310
|
/**
|
1219
1311
|
* Provides utility method to build bot message with cards that supported in Teams.
|
1312
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1220
1313
|
*/
|
1221
1314
|
export declare class MessageBuilder {
|
1222
1315
|
/**
|
@@ -1254,6 +1347,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1254
1347
|
* description: "sample card description"
|
1255
1348
|
* });
|
1256
1349
|
* ```
|
1350
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1257
1351
|
*/
|
1258
1352
|
static attachAdaptiveCard<TData extends object>(cardTemplate: unknown, data: TData): Partial<Activity>;
|
1259
1353
|
/**
|
@@ -1261,6 +1355,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1261
1355
|
*
|
1262
1356
|
* @param card The adaptive card content.
|
1263
1357
|
* @returns A bot message activity attached with an adaptive card.
|
1358
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1264
1359
|
*/
|
1265
1360
|
static attachAdaptiveCardWithoutData(card: unknown): Partial<Activity>;
|
1266
1361
|
/**
|
@@ -1282,6 +1377,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1282
1377
|
* ['action']
|
1283
1378
|
* );
|
1284
1379
|
* ```
|
1380
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1285
1381
|
*/
|
1286
1382
|
static attachHeroCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<HeroCard>): Partial<Activity>;
|
1287
1383
|
/**
|
@@ -1295,6 +1391,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1295
1391
|
*
|
1296
1392
|
* @remarks
|
1297
1393
|
* For channels that don't natively support sign-in cards, an alternative message is rendered.
|
1394
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1298
1395
|
*/
|
1299
1396
|
static attachSigninCard(title: string, url: string, text?: string): Partial<Activity>;
|
1300
1397
|
/**
|
@@ -1302,12 +1399,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1302
1399
|
*
|
1303
1400
|
* @param card A description of the Office 365 connector card.
|
1304
1401
|
* @returns A bot message activity attached with an Office 365 connector card.
|
1402
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1305
1403
|
*/
|
1306
1404
|
static attachO365ConnectorCard(card: O365ConnectorCard): Partial<Activity>;
|
1307
1405
|
/**
|
1308
1406
|
* Build a message activity attached with a receipt card.
|
1309
1407
|
* @param card A description of the receipt card.
|
1310
1408
|
* @returns A message activity attached with a receipt card.
|
1409
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1311
1410
|
*/
|
1312
1411
|
static AttachReceiptCard(card: ReceiptCard): Partial<Activity>;
|
1313
1412
|
/**
|
@@ -1318,18 +1417,22 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1318
1417
|
* is converted to an `imBack` button with a title and value set to the value of the string.
|
1319
1418
|
* @param other Optional. Any additional properties to include on the card.
|
1320
1419
|
* @returns A message activity attached with a thumbnail card
|
1420
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1321
1421
|
*/
|
1322
1422
|
static attachThumbnailCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<ThumbnailCard>): Partial<Activity>;
|
1323
1423
|
/**
|
1324
1424
|
* Add an attachement to a bot activity.
|
1325
1425
|
* @param attachement The attachment object to attach.
|
1326
1426
|
* @returns A message activity with an attachment.
|
1427
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1327
1428
|
*/
|
1328
1429
|
static attachContent(attachement: Attachment): Partial<Activity>;
|
1329
1430
|
}
|
1330
1431
|
|
1331
1432
|
/**
|
1332
1433
|
* Token response provided by Teams Bot SSO prompt
|
1434
|
+
*
|
1435
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1333
1436
|
*/
|
1334
1437
|
export declare interface MessageExtensionTokenResponse {
|
1335
1438
|
/**
|
@@ -1351,6 +1454,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1351
1454
|
|
1352
1455
|
/**
|
1353
1456
|
* The response of a message action, e.g., `sendMessage`, `sendAdaptiveCard`.
|
1457
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1354
1458
|
*/
|
1355
1459
|
declare interface MessageResponse {
|
1356
1460
|
/**
|
@@ -1361,6 +1465,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1361
1465
|
|
1362
1466
|
/**
|
1363
1467
|
* Provide utilities to send notification to varies targets (e.g., member, group, channel).
|
1468
|
+
*
|
1469
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1364
1470
|
*/
|
1365
1471
|
declare class NotificationBot {
|
1366
1472
|
private readonly conversationReferenceStore;
|
@@ -1459,6 +1565,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1459
1565
|
|
1460
1566
|
/**
|
1461
1567
|
* Options to initialize {@link NotificationBot}.
|
1568
|
+
*
|
1569
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1462
1570
|
*/
|
1463
1571
|
declare interface NotificationOptions_2 {
|
1464
1572
|
/**
|
@@ -1484,6 +1592,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1484
1592
|
|
1485
1593
|
/**
|
1486
1594
|
* Represent a notification target.
|
1595
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1487
1596
|
*/
|
1488
1597
|
export declare interface NotificationTarget {
|
1489
1598
|
/**
|
@@ -1519,6 +1628,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1519
1628
|
* - "Channel" means to a team channel. (By default, notification to a team will be sent to its "General" channel.)
|
1520
1629
|
* - "Group" means to a group chat.
|
1521
1630
|
* - "Person" means to a personal chat.
|
1631
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1522
1632
|
*/
|
1523
1633
|
export declare enum NotificationTargetType {
|
1524
1634
|
/**
|
@@ -1538,6 +1648,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1538
1648
|
|
1539
1649
|
/**
|
1540
1650
|
* Authentication configuration for OnBehalfOfCredential used in node environment
|
1651
|
+
*
|
1652
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1541
1653
|
*/
|
1542
1654
|
export declare type OnBehalfOfCredentialAuthConfig = {
|
1543
1655
|
/**
|
@@ -1573,6 +1685,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1573
1685
|
/**
|
1574
1686
|
* Represent on-behalf-of flow to get user identity, and it is designed to be used in server side.
|
1575
1687
|
*
|
1688
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1576
1689
|
* @example
|
1577
1690
|
* ```typescript
|
1578
1691
|
* const credential = new OnBehalfOfUserCredential(ssoToken);
|
@@ -1587,6 +1700,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1587
1700
|
/**
|
1588
1701
|
* Constructor of OnBehalfOfUserCredential
|
1589
1702
|
*
|
1703
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1590
1704
|
* @remarks
|
1591
1705
|
* Only works in in server side.
|
1592
1706
|
*
|
@@ -1601,6 +1715,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1601
1715
|
/**
|
1602
1716
|
* Get access token from credential.
|
1603
1717
|
*
|
1718
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1604
1719
|
* @example
|
1605
1720
|
* ```typescript
|
1606
1721
|
* await credential.getToken([]) // Get SSO token using empty string array
|
@@ -1651,6 +1766,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1651
1766
|
|
1652
1767
|
/**
|
1653
1768
|
* Represents a page of data.
|
1769
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1654
1770
|
*/
|
1655
1771
|
export declare interface PagedData<T> {
|
1656
1772
|
/**
|
@@ -1670,6 +1786,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1670
1786
|
* The search scope when calling {@link NotificationBot.findMember} and {@link NotificationBot.findAllMembers}.
|
1671
1787
|
* The search scope is a flagged enum and it can be combined with `|`.
|
1672
1788
|
* For example, to search from personal chat and group chat, use `SearchScope.Person | SearchScope.Group`.
|
1789
|
+
*
|
1790
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1673
1791
|
*/
|
1674
1792
|
declare enum SearchScope {
|
1675
1793
|
/**
|
@@ -1693,6 +1811,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1693
1811
|
/**
|
1694
1812
|
* Send an adaptive card message to a notification target.
|
1695
1813
|
*
|
1814
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1696
1815
|
* @param target - The notification target.
|
1697
1816
|
* @param card - The adaptive card raw JSON.
|
1698
1817
|
* @param onError - An optional error handler that can catch exceptions during adaptive card sending.
|
@@ -1705,6 +1824,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1705
1824
|
/**
|
1706
1825
|
* Send a plain text message to a notification target.
|
1707
1826
|
*
|
1827
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1708
1828
|
* @param target - The notification target.
|
1709
1829
|
* @param text - The plain text message.
|
1710
1830
|
* @param onError - An optional error handler that can catch exceptions during message sending.
|
@@ -1717,6 +1837,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1717
1837
|
/**
|
1718
1838
|
* Set custom log function. Use the function if it's set. Priority is lower than setLogger.
|
1719
1839
|
*
|
1840
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1841
|
+
*
|
1720
1842
|
* @param {LogFunction} logFunction - custom log function. If it's undefined, custom log function will be cleared.
|
1721
1843
|
*
|
1722
1844
|
* @example
|
@@ -1733,6 +1855,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1733
1855
|
/**
|
1734
1856
|
* Set custom logger. Use the output functions if it's set. Priority is higher than setLogFunction.
|
1735
1857
|
*
|
1858
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1859
|
+
*
|
1736
1860
|
* @param {Logger} logger - custom logger. If it's undefined, custom logger will be cleared.
|
1737
1861
|
*
|
1738
1862
|
* @example
|
@@ -1750,6 +1874,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1750
1874
|
/**
|
1751
1875
|
* Update log level helper.
|
1752
1876
|
*
|
1877
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1878
|
+
*
|
1753
1879
|
* @param { LogLevel } level - log level in configuration
|
1754
1880
|
*/
|
1755
1881
|
export declare function setLogLevel(level: LogLevel): void;
|
@@ -1760,6 +1886,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1760
1886
|
* - Group chat
|
1761
1887
|
* - Team (by default the `General` channel)
|
1762
1888
|
*
|
1889
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1763
1890
|
* @remarks
|
1764
1891
|
* It's recommended to get bot installations from {@link ConversationBot.installations()}.
|
1765
1892
|
*/
|
@@ -1885,6 +2012,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1885
2012
|
* }
|
1886
2013
|
* ]));
|
1887
2014
|
* ```
|
2015
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1888
2016
|
*/
|
1889
2017
|
export declare class TeamsBotSsoPrompt extends Dialog {
|
1890
2018
|
private authConfig;
|
@@ -1900,6 +2028,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1900
2028
|
*
|
1901
2029
|
* @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
|
1902
2030
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
2031
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1903
2032
|
*/
|
1904
2033
|
constructor(authConfig: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, dialogId: string, settings: TeamsBotSsoPromptSettings);
|
1905
2034
|
/**
|
@@ -1915,6 +2044,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1915
2044
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
1916
2045
|
*
|
1917
2046
|
* @returns A `Promise` representing the asynchronous operation.
|
2047
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1918
2048
|
*/
|
1919
2049
|
beginDialog(dc: DialogContext): Promise<DialogTurnResult>;
|
1920
2050
|
/**
|
@@ -1932,6 +2062,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1932
2062
|
*
|
1933
2063
|
* @throws {@link ErrorCode|ChannelNotSupported} when bot channel is not MS Teams.
|
1934
2064
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
2065
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1935
2066
|
*/
|
1936
2067
|
continueDialog(dc: DialogContext): Promise<DialogTurnResult>;
|
1937
2068
|
/**
|
@@ -1980,6 +2111,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1980
2111
|
|
1981
2112
|
/**
|
1982
2113
|
* Settings used to configure an TeamsBotSsoPrompt instance.
|
2114
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1983
2115
|
*/
|
1984
2116
|
export declare interface TeamsBotSsoPromptSettings {
|
1985
2117
|
/**
|
@@ -2002,6 +2134,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2002
2134
|
|
2003
2135
|
/**
|
2004
2136
|
* Token response provided by Teams Bot SSO prompt
|
2137
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2005
2138
|
*/
|
2006
2139
|
export declare interface TeamsBotSsoPromptTokenResponse {
|
2007
2140
|
/**
|
@@ -2023,6 +2156,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2023
2156
|
|
2024
2157
|
/**
|
2025
2158
|
* Interface for adaptive card action handler that can process card action invoke and return a response.
|
2159
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2026
2160
|
*/
|
2027
2161
|
export declare interface TeamsFxAdaptiveCardActionHandler {
|
2028
2162
|
/**
|
@@ -2064,6 +2198,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2064
2198
|
|
2065
2199
|
/**
|
2066
2200
|
* Interface for a command handler that can process command to a TeamsFx bot and return a response.
|
2201
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2067
2202
|
*/
|
2068
2203
|
export declare interface TeamsFxBotCommandHandler {
|
2069
2204
|
/**
|
@@ -2083,6 +2218,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2083
2218
|
|
2084
2219
|
/**
|
2085
2220
|
* Interface for a command handler that can process sso command to a TeamsFx bot and return a response.
|
2221
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2086
2222
|
*/
|
2087
2223
|
export declare interface TeamsFxBotSsoCommandHandler {
|
2088
2224
|
/**
|
@@ -2104,12 +2240,15 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2104
2240
|
/**
|
2105
2241
|
* Represent Teams current user's identity, and it is used within Teams client applications.
|
2106
2242
|
*
|
2243
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2107
2244
|
* @remarks
|
2108
2245
|
* Can only be used within Teams.
|
2109
2246
|
*/
|
2110
2247
|
export declare class TeamsUserCredential implements TokenCredential {
|
2111
2248
|
/**
|
2112
2249
|
* Constructor of TeamsUserCredential.
|
2250
|
+
*
|
2251
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2113
2252
|
* @remarks
|
2114
2253
|
* Can only be used within Teams.
|
2115
2254
|
*/
|
@@ -2117,6 +2256,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2117
2256
|
/**
|
2118
2257
|
* Popup login page to get user's access token with specific scopes.
|
2119
2258
|
*
|
2259
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2120
2260
|
* @param {string[]} resources - The optional list of resources for full trust Teams apps.
|
2121
2261
|
*
|
2122
2262
|
* @remarks
|
@@ -2125,6 +2265,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2125
2265
|
login(scopes: string | string[], resources?: string[]): Promise<void>;
|
2126
2266
|
/**
|
2127
2267
|
* Get access token from credential.
|
2268
|
+
*
|
2269
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2128
2270
|
* @remarks
|
2129
2271
|
* Can only be used within Teams.
|
2130
2272
|
*/
|
@@ -2132,6 +2274,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2132
2274
|
/**
|
2133
2275
|
* Get basic user info from SSO token
|
2134
2276
|
*
|
2277
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2135
2278
|
* @param {string[]} resources - The optional list of resources for full trust Teams apps.
|
2136
2279
|
*
|
2137
2280
|
* @remarks
|
@@ -2142,6 +2285,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2142
2285
|
|
2143
2286
|
/**
|
2144
2287
|
* Authentication configuration for TeamsUserCredential used in browser environment
|
2288
|
+
*
|
2289
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2145
2290
|
*/
|
2146
2291
|
export declare type TeamsUserCredentialAuthConfig = {
|
2147
2292
|
/**
|
@@ -2156,11 +2301,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2156
2301
|
|
2157
2302
|
/**
|
2158
2303
|
* The trigger pattern used to trigger a {@link TeamsFxBotCommandHandler} instance.
|
2304
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2159
2305
|
*/
|
2160
2306
|
export declare type TriggerPatterns = string | RegExp | (string | RegExp)[];
|
2161
2307
|
|
2162
2308
|
/**
|
2163
2309
|
* UserInfo with user displayName, objectId and preferredUserName.
|
2310
|
+
*
|
2311
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
2164
2312
|
*/
|
2165
2313
|
export declare interface UserInfo {
|
2166
2314
|
/**
|