@microsoft/teamsfx 4.0.1-alpha.10d26a09f.0 → 4.0.1-alpha.1c9fbe536.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.map +1 -1
- package/dist/index.esm5.js.map +1 -1
- package/dist/index.node.cjs.js.map +1 -1
- package/dist/types/teamsfx.d.ts +145 -0
- package/package.json +2 -2
package/dist/types/teamsfx.d.ts
CHANGED
@@ -37,6 +37,7 @@ import { UserState } from '@microsoft/agents-hosting';
|
|
37
37
|
|
38
38
|
/**
|
39
39
|
* Options used to control how the response card will be sent to users.
|
40
|
+
* @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
41
|
*/
|
41
42
|
export declare enum AdaptiveCardResponse {
|
42
43
|
/**
|
@@ -74,6 +75,7 @@ export { AgentBuilderCloudAdapter }
|
|
74
75
|
|
75
76
|
/**
|
76
77
|
* Define available location for API Key location
|
78
|
+
* @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
79
|
*/
|
78
80
|
export declare enum ApiKeyLocation {
|
79
81
|
/**
|
@@ -88,6 +90,7 @@ export declare enum ApiKeyLocation {
|
|
88
90
|
|
89
91
|
/**
|
90
92
|
* Provider that handles API Key authentication
|
93
|
+
* @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
94
|
*/
|
92
95
|
export declare class ApiKeyProvider implements AuthProvider {
|
93
96
|
private keyName;
|
@@ -101,6 +104,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
101
104
|
*
|
102
105
|
* @throws {@link ErrorCode|InvalidParameter} - when key name or key value is empty.
|
103
106
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
107
|
+
* @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
108
|
*/
|
105
109
|
constructor(keyName: string, keyValue: string, keyLocation: ApiKeyLocation);
|
106
110
|
/**
|
@@ -113,6 +117,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
113
117
|
*
|
114
118
|
* @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when API key already exists in request header or url query parameter.
|
115
119
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
120
|
+
* @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
121
|
*/
|
117
122
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
118
123
|
}
|
@@ -120,6 +125,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
120
125
|
/**
|
121
126
|
* Represent Microsoft 365 tenant identity, and it is usually used when user is not involved like time-triggered automation job.
|
122
127
|
*
|
128
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
129
|
+
*
|
123
130
|
* @example
|
124
131
|
* ```typescript
|
125
132
|
* loadConfiguration(); // load configuration from environment variables
|
@@ -134,6 +141,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
134
141
|
/**
|
135
142
|
* Constructor of AppCredential.
|
136
143
|
*
|
144
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
145
|
+
*
|
137
146
|
* @remarks
|
138
147
|
* Only works in in server side.
|
139
148
|
*
|
@@ -146,6 +155,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
146
155
|
/**
|
147
156
|
* Get access token for credential.
|
148
157
|
*
|
158
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
159
|
+
*
|
149
160
|
* @example
|
150
161
|
* ```typescript
|
151
162
|
* await credential.getToken(["User.Read.All"]) // Get Graph access token for single scope using string array
|
@@ -180,11 +191,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
180
191
|
|
181
192
|
/**
|
182
193
|
* Authentication configuration for AppCredential used in node environment
|
194
|
+
*
|
195
|
+
* @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
196
|
*/
|
184
197
|
export declare type AppCredentialAuthConfig = OnBehalfOfCredentialAuthConfig;
|
185
198
|
|
186
199
|
/**
|
187
200
|
* Defines method that injects authentication info to http requests
|
201
|
+
* @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
202
|
*/
|
189
203
|
export declare interface AuthProvider {
|
190
204
|
/**
|
@@ -192,6 +206,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
192
206
|
*
|
193
207
|
* @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
|
194
208
|
* Refer https://axios-http.com/docs/req_config for detailed document.
|
209
|
+
* @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
210
|
*/
|
196
211
|
AddAuthenticationInfo: (config: AxiosRequestConfig) => Promise<AxiosRequestConfig>;
|
197
212
|
}
|
@@ -200,6 +215,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
200
215
|
|
201
216
|
/**
|
202
217
|
* Provider that handles Basic authentication
|
218
|
+
* @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
219
|
*/
|
204
220
|
export declare class BasicAuthProvider implements AuthProvider {
|
205
221
|
private userName;
|
@@ -211,6 +227,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
211
227
|
*
|
212
228
|
* @throws {@link ErrorCode|InvalidParameter} - when username or password is empty.
|
213
229
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
230
|
+
* @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
231
|
*/
|
215
232
|
constructor(userName: string, password: string);
|
216
233
|
/**
|
@@ -223,17 +240,20 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
223
240
|
*
|
224
241
|
* @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header or auth property already exists in request configuration.
|
225
242
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
243
|
+
* @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
244
|
*/
|
227
245
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
228
246
|
}
|
229
247
|
|
230
248
|
/**
|
231
249
|
* Provider that handles Bearer Token authentication
|
250
|
+
* @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
251
|
*/
|
233
252
|
export declare class BearerTokenAuthProvider implements AuthProvider {
|
234
253
|
private getToken;
|
235
254
|
/**
|
236
255
|
* @param { () => Promise<string> } getToken - Function that returns the content of bearer token used in http request
|
256
|
+
* @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
257
|
*/
|
238
258
|
constructor(getToken: () => Promise<string>);
|
239
259
|
/**
|
@@ -245,12 +265,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
245
265
|
* @returns Updated axios request config.
|
246
266
|
*
|
247
267
|
* @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header already exists in request configuration.
|
268
|
+
* @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
269
|
*/
|
249
270
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
250
271
|
}
|
251
272
|
|
252
273
|
/**
|
253
274
|
* Interface for SSO configuration for Bot SSO
|
275
|
+
* @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
276
|
*/
|
255
277
|
export declare interface BotSsoConfig {
|
256
278
|
/**
|
@@ -321,6 +343,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
321
343
|
* });
|
322
344
|
* ```
|
323
345
|
* For details information about how to implement a BotSsoExecutionActivityHandler, please refer DefaultBotSsoExecutionActivityHandler class source code: https://aka.ms/teamsfx-default-sso-execution-activity-handler
|
346
|
+
* @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
347
|
*/
|
325
348
|
export declare interface BotSsoExecutionActivityHandler {
|
326
349
|
/**
|
@@ -361,6 +384,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
361
384
|
|
362
385
|
/**
|
363
386
|
* Sso execution dialog, use to handle sso command
|
387
|
+
* @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
388
|
*/
|
365
389
|
export declare class BotSsoExecutionDialog extends ComponentDialog {
|
366
390
|
private dedupStorage;
|
@@ -373,12 +397,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
373
397
|
* @param {@link OnBehalfOfCredentialAuthConfig} authConfig The authentication configuration.
|
374
398
|
* @param {string} initiateLoginEndpoint Login URL for Teams to redirect to.
|
375
399
|
* @param {string} dialogName custom dialog name
|
400
|
+
* @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
401
|
*/
|
377
402
|
constructor(dedupStorage: Storage_2, ssoPromptSettings: TeamsBotSsoPromptSettings, authConfig: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, dialogName?: string);
|
378
403
|
/**
|
379
404
|
* Add TeamsFxBotSsoCommandHandler instance
|
380
405
|
* @param handler {@link BotSsoExecutionDialogHandler} callback function
|
381
406
|
* @param triggerPatterns The trigger pattern
|
407
|
+
* @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
408
|
*/
|
383
409
|
addCommand(handler: BotSsoExecutionDialogHandler, triggerPatterns: TriggerPatterns): void;
|
384
410
|
private getCommandHash;
|
@@ -387,6 +413,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
387
413
|
*
|
388
414
|
* @param context The context object for the current turn.
|
389
415
|
* @param accessor The instance of StatePropertyAccessor for dialog system.
|
416
|
+
* @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
417
|
*/
|
391
418
|
run(context: TurnContext, accessor: AgentStatePropertyAccessor): Promise<void>;
|
392
419
|
private getActivityText;
|
@@ -421,10 +448,15 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
421
448
|
private ensureMsTeamsChannel;
|
422
449
|
}
|
423
450
|
|
451
|
+
/**
|
452
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
453
|
+
*/
|
424
454
|
export declare type BotSsoExecutionDialogHandler = (context: TurnContext, tokenResponse: TeamsBotSsoPromptTokenResponse, message: CommandMessage) => Promise<void>;
|
425
455
|
|
426
456
|
/**
|
427
457
|
* A card action bot to respond to adaptive card universal actions.
|
458
|
+
*
|
459
|
+
* @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
460
|
*/
|
429
461
|
declare class CardActionBot {
|
430
462
|
private readonly adapter;
|
@@ -432,6 +464,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
432
464
|
/**
|
433
465
|
* Create a new instance of the `CardActionBot`.
|
434
466
|
*
|
467
|
+
* @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
468
|
* @param adapter - The bound `CloudAdapter`.
|
436
469
|
* @param options - The initialize options.
|
437
470
|
*/
|
@@ -439,12 +472,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
439
472
|
/**
|
440
473
|
* Register a card action handler to the bot.
|
441
474
|
*
|
475
|
+
* @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
476
|
* @param actionHandler - A card action handler to be registered.
|
443
477
|
*/
|
444
478
|
registerHandler(actionHandler: TeamsFxAdaptiveCardActionHandler): void;
|
445
479
|
/**
|
446
480
|
* Register card action handlers to the bot.
|
447
481
|
*
|
482
|
+
* @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
483
|
* @param actionHandlers - A set of card action handlers to be registered.
|
449
484
|
*/
|
450
485
|
registerHandlers(actionHandlers: TeamsFxAdaptiveCardActionHandler[]): void;
|
@@ -452,6 +487,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
452
487
|
|
453
488
|
/**
|
454
489
|
* Options to initialize {@link CardActionBot}.
|
490
|
+
* @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
491
|
*/
|
456
492
|
export declare interface CardActionOptions {
|
457
493
|
/**
|
@@ -462,6 +498,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
462
498
|
|
463
499
|
/**
|
464
500
|
* Provider that handles Certificate authentication
|
501
|
+
* @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
502
|
*/
|
466
503
|
export declare class CertificateAuthProvider implements AuthProvider {
|
467
504
|
private certOption;
|
@@ -470,6 +507,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
470
507
|
* @param { SecureContextOptions } certOption - information about the cert used in http requests
|
471
508
|
*
|
472
509
|
* @throws {@link ErrorCode|InvalidParameter} - when cert option is empty.
|
510
|
+
* @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
511
|
*/
|
474
512
|
constructor(certOption: SecureContextOptions);
|
475
513
|
/**
|
@@ -481,6 +519,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
481
519
|
* @returns Updated axios request config.
|
482
520
|
*
|
483
521
|
* @throws {@link ErrorCode|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
|
522
|
+
* @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
523
|
*/
|
485
524
|
AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
486
525
|
}
|
@@ -488,6 +527,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
488
527
|
/**
|
489
528
|
* A {@link NotificationTarget} that represents a team channel.
|
490
529
|
*
|
530
|
+
* @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
531
|
* @remarks
|
492
532
|
* It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
|
493
533
|
*/
|
@@ -507,6 +547,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
507
547
|
/**
|
508
548
|
* Constructor.
|
509
549
|
*
|
550
|
+
* @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
551
|
* @remarks
|
511
552
|
* It's recommended to get channels from {@link TeamsBotInstallation.channels()}, instead of using this constructor.
|
512
553
|
*
|
@@ -517,6 +558,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
517
558
|
/**
|
518
559
|
* Send a plain text message.
|
519
560
|
*
|
561
|
+
* @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
562
|
* @param text - The plain text message.
|
521
563
|
* @param onError - An optional error handler that can catch exceptions during message sending.
|
522
564
|
* If not defined, error will be handled by `BotAdapter.onTurnError`.
|
@@ -527,6 +569,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
527
569
|
/**
|
528
570
|
* Send an adaptive card message.
|
529
571
|
*
|
572
|
+
* @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
573
|
* @param card - The adaptive card raw JSON.
|
531
574
|
* @param onError - An optional error handler that can catch exceptions during adaptive card sending.
|
532
575
|
* If not defined, error will be handled by `BotAdapter.onTurnError`.
|
@@ -543,6 +586,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
543
586
|
/**
|
544
587
|
* A command bot for receiving commands and sending responses in Teams.
|
545
588
|
*
|
589
|
+
* @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
590
|
* @remarks
|
547
591
|
* 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
592
|
*/
|
@@ -553,6 +597,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
553
597
|
/**
|
554
598
|
* Create a new instance of the `CommandBot`.
|
555
599
|
*
|
600
|
+
* @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
601
|
* @param adapter - The bound `CloudAdapter`.
|
557
602
|
* @param options - The initialize options
|
558
603
|
* @param ssoCommandActivityHandler - SSO execution activity handler.
|
@@ -562,24 +607,28 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
562
607
|
/**
|
563
608
|
* Register a command into the command bot.
|
564
609
|
*
|
610
|
+
* @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
611
|
* @param command - The command to be registered.
|
566
612
|
*/
|
567
613
|
registerCommand(command: TeamsFxBotCommandHandler): void;
|
568
614
|
/**
|
569
615
|
* Register commands into the command bot.
|
570
616
|
*
|
617
|
+
* @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
618
|
* @param commands - The commands to be registered.
|
572
619
|
*/
|
573
620
|
registerCommands(commands: TeamsFxBotCommandHandler[]): void;
|
574
621
|
/**
|
575
622
|
* Register a sso command into the command bot.
|
576
623
|
*
|
624
|
+
* @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
625
|
* @param ssoCommand - The sso command to be registered.
|
578
626
|
*/
|
579
627
|
registerSsoCommand(ssoCommand: TeamsFxBotSsoCommandHandler): void;
|
580
628
|
/**
|
581
629
|
* Register sso commands into the command bot.
|
582
630
|
*
|
631
|
+
* @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
632
|
* @param ssoCommands - The sso commands to be registered.
|
584
633
|
*/
|
585
634
|
registerSsoCommands(ssoCommands: TeamsFxBotSsoCommandHandler[]): void;
|
@@ -588,6 +637,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
588
637
|
|
589
638
|
/**
|
590
639
|
* Interface for a command message that can handled in a command handler.
|
640
|
+
* @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
641
|
*/
|
592
642
|
export declare interface CommandMessage {
|
593
643
|
/**
|
@@ -602,6 +652,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
602
652
|
|
603
653
|
/**
|
604
654
|
* Options to initialize {@link CommandBot}.
|
655
|
+
* @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
656
|
*/
|
606
657
|
export declare interface CommandOptions {
|
607
658
|
/**
|
@@ -619,6 +670,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
619
670
|
* - handle command and response.
|
620
671
|
* - send notification to varies targets (e.g., member, group, channel).
|
621
672
|
*
|
673
|
+
* @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
674
|
* @example
|
623
675
|
* For command and response, you can register your commands through the constructor, or use the `registerCommand` and `registerCommands` API to add commands later.
|
624
676
|
*
|
@@ -691,6 +743,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
691
743
|
/**
|
692
744
|
* Create new instance of the `ConversationBot`.
|
693
745
|
*
|
746
|
+
* @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
747
|
* @remarks
|
695
748
|
* It's recommended to create your own adapter and storage for production environment instead of the default one.
|
696
749
|
*
|
@@ -701,6 +754,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
701
754
|
/**
|
702
755
|
* The request handler to integrate with web request.
|
703
756
|
*
|
757
|
+
* @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
758
|
* @param req - An incoming HTTP [Request](xref:botbuilder.Request).
|
705
759
|
* @param res - The corresponding HTTP [Response](xref:botbuilder.Response).
|
706
760
|
* @param logic - The additional function to handle bot context.
|
@@ -728,6 +782,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
728
782
|
|
729
783
|
/**
|
730
784
|
* Options to initialize {@link ConversationBot}
|
785
|
+
*
|
786
|
+
* @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
787
|
*/
|
732
788
|
declare interface ConversationOptions {
|
733
789
|
/**
|
@@ -781,6 +837,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
781
837
|
|
782
838
|
/**
|
783
839
|
* A store to persist notification target references.
|
840
|
+
* @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
841
|
*/
|
785
842
|
export declare interface ConversationReferenceStore {
|
786
843
|
/**
|
@@ -815,6 +872,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
815
872
|
|
816
873
|
/**
|
817
874
|
* Options to add a conversation reference to the store.
|
875
|
+
* @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
876
|
*/
|
819
877
|
export declare interface ConversationReferenceStoreAddOptions {
|
820
878
|
/**
|
@@ -834,6 +892,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
834
892
|
* ```typescript
|
835
893
|
* const client = createApiClient("https://my-api-endpoint-base-url", new BasicAuthProvider("xxx","xxx"));
|
836
894
|
* ```
|
895
|
+
* @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
896
|
*/
|
838
897
|
export declare function createApiClient(apiEndpoint: string, authProvider: AuthProvider): AxiosInstance;
|
839
898
|
|
@@ -847,6 +906,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
847
906
|
* @returns Instance of SecureContextOptions
|
848
907
|
*
|
849
908
|
* @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
|
909
|
+
* @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
910
|
*
|
851
911
|
*/
|
852
912
|
export declare function createPemCertOption(cert: string | Buffer, key: string | Buffer, options?: {
|
@@ -863,6 +923,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
863
923
|
* @returns Instance of SecureContextOptions
|
864
924
|
*
|
865
925
|
* @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
|
926
|
+
* @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
927
|
*
|
867
928
|
*/
|
868
929
|
export declare function createPfxCertOption(pfx: string | Buffer, options?: {
|
@@ -871,6 +932,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
871
932
|
|
872
933
|
/**
|
873
934
|
* Error code to trace the error types.
|
935
|
+
*
|
936
|
+
* @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
937
|
*/
|
875
938
|
export declare enum ErrorCode {
|
876
939
|
/**
|
@@ -953,6 +1016,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
953
1016
|
|
954
1017
|
/**
|
955
1018
|
* Error class with code and message thrown by the SDK.
|
1019
|
+
*
|
1020
|
+
* @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
1021
|
*/
|
957
1022
|
export declare class ErrorWithCode extends Error {
|
958
1023
|
/**
|
@@ -964,6 +1029,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
964
1029
|
/**
|
965
1030
|
* Constructor of ErrorWithCode.
|
966
1031
|
*
|
1032
|
+
* @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
1033
|
* @param {string} message - error message.
|
968
1034
|
* @param {ErrorCode} code - error code.
|
969
1035
|
*/
|
@@ -973,10 +1039,15 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
973
1039
|
/**
|
974
1040
|
* Get log level.
|
975
1041
|
*
|
1042
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1043
|
+
*
|
976
1044
|
* @returns Log level
|
977
1045
|
*/
|
978
1046
|
export declare function getLogLevel(): LogLevel | undefined;
|
979
1047
|
|
1048
|
+
/**
|
1049
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1050
|
+
*/
|
980
1051
|
export declare interface GetTeamsUserTokenOptions extends GetTokenOptions {
|
981
1052
|
resources?: string[];
|
982
1053
|
}
|
@@ -984,6 +1055,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
984
1055
|
/**
|
985
1056
|
* Users execute link query in message extension with SSO or access token.
|
986
1057
|
*
|
1058
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1059
|
+
*
|
987
1060
|
* @param {TurnContext} context - The context object for the current turn.
|
988
1061
|
* @param {OnBehalfOfCredentialAuthConfig} config - User custom the message extension authentication configuration.
|
989
1062
|
* @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
|
@@ -1004,6 +1077,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1004
1077
|
/**
|
1005
1078
|
* Users execute query in message extension with SSO or access token.
|
1006
1079
|
*
|
1080
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1081
|
+
*
|
1007
1082
|
* @param {TurnContext} context - The context object for the current turn.
|
1008
1083
|
* @param {OnBehalfOfCredentialAuthConfig} config - User custom the message extension authentication configuration.
|
1009
1084
|
* @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
|
@@ -1023,6 +1098,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1023
1098
|
|
1024
1099
|
/**
|
1025
1100
|
* Status code for an `application/vnd.microsoft.error` invoke response.
|
1101
|
+
* @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
1102
|
*/
|
1027
1103
|
export declare enum InvokeResponseErrorCode {
|
1028
1104
|
/**
|
@@ -1063,6 +1139,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1063
1139
|
* value: invokeResponse,
|
1064
1140
|
* });
|
1065
1141
|
* ```
|
1142
|
+
* @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
1143
|
*/
|
1067
1144
|
export declare class InvokeResponseFactory {
|
1068
1145
|
/**
|
@@ -1073,6 +1150,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1073
1150
|
* @param message - A text message included in a invoke response.
|
1074
1151
|
*
|
1075
1152
|
* @returns An `InvokeResponse` object.
|
1153
|
+
* @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
1154
|
*/
|
1077
1155
|
static textMessage(message: string): InvokeResponse;
|
1078
1156
|
/**
|
@@ -1085,6 +1163,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1085
1163
|
* @param card - The adaptive card JSON payload.
|
1086
1164
|
*
|
1087
1165
|
* @returns An `InvokeResponse` object.
|
1166
|
+
* @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
1167
|
*/
|
1089
1168
|
static adaptiveCard(card: unknown): InvokeResponse;
|
1090
1169
|
/**
|
@@ -1099,6 +1178,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1099
1178
|
* @param errorMessage - The error message.
|
1100
1179
|
*
|
1101
1180
|
* @returns An `InvokeResponse` object.
|
1181
|
+
* @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
1182
|
*/
|
1103
1183
|
static errorResponse(errorCode: InvokeResponseErrorCode, errorMessage: string): InvokeResponse;
|
1104
1184
|
/**
|
@@ -1107,17 +1187,22 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1107
1187
|
* @param body - The value of the response body.
|
1108
1188
|
*
|
1109
1189
|
* @returns An `InvokeResponse` object.
|
1190
|
+
* @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
1191
|
*/
|
1111
1192
|
static createInvokeResponse(statusCode: StatusCodes, body?: unknown): InvokeResponse;
|
1112
1193
|
}
|
1113
1194
|
|
1114
1195
|
/**
|
1115
1196
|
* Log function for customized logging.
|
1197
|
+
*
|
1198
|
+
* @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
1199
|
*/
|
1117
1200
|
export declare type LogFunction = (level: LogLevel, message: string) => void;
|
1118
1201
|
|
1119
1202
|
/**
|
1120
1203
|
* Interface for customized logger.
|
1204
|
+
*
|
1205
|
+
* @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
1206
|
*/
|
1122
1207
|
export declare interface Logger {
|
1123
1208
|
/**
|
@@ -1140,6 +1225,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1140
1225
|
|
1141
1226
|
/**
|
1142
1227
|
* Log level.
|
1228
|
+
*
|
1229
|
+
* @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
1230
|
*/
|
1144
1231
|
export declare enum LogLevel {
|
1145
1232
|
/**
|
@@ -1163,6 +1250,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1163
1250
|
/**
|
1164
1251
|
* A {@link NotificationTarget} that represents a team member.
|
1165
1252
|
*
|
1253
|
+
* @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
1254
|
* @remarks
|
1167
1255
|
* It's recommended to get members from {@link TeamsBotInstallation.members()}.
|
1168
1256
|
*/
|
@@ -1182,6 +1270,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1182
1270
|
/**
|
1183
1271
|
* Constructor.
|
1184
1272
|
*
|
1273
|
+
* @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
1274
|
* @remarks
|
1186
1275
|
* It's recommended to get members from {@link TeamsBotInstallation.members()}, instead of using this constructor.
|
1187
1276
|
*
|
@@ -1217,6 +1306,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1217
1306
|
|
1218
1307
|
/**
|
1219
1308
|
* Provides utility method to build bot message with cards that supported in Teams.
|
1309
|
+
* @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
1310
|
*/
|
1221
1311
|
export declare class MessageBuilder {
|
1222
1312
|
/**
|
@@ -1254,6 +1344,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1254
1344
|
* description: "sample card description"
|
1255
1345
|
* });
|
1256
1346
|
* ```
|
1347
|
+
* @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
1348
|
*/
|
1258
1349
|
static attachAdaptiveCard<TData extends object>(cardTemplate: unknown, data: TData): Partial<Activity>;
|
1259
1350
|
/**
|
@@ -1261,6 +1352,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1261
1352
|
*
|
1262
1353
|
* @param card The adaptive card content.
|
1263
1354
|
* @returns A bot message activity attached with an adaptive card.
|
1355
|
+
* @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
1356
|
*/
|
1265
1357
|
static attachAdaptiveCardWithoutData(card: unknown): Partial<Activity>;
|
1266
1358
|
/**
|
@@ -1282,6 +1374,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1282
1374
|
* ['action']
|
1283
1375
|
* );
|
1284
1376
|
* ```
|
1377
|
+
* @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
1378
|
*/
|
1286
1379
|
static attachHeroCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<HeroCard>): Partial<Activity>;
|
1287
1380
|
/**
|
@@ -1295,6 +1388,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1295
1388
|
*
|
1296
1389
|
* @remarks
|
1297
1390
|
* For channels that don't natively support sign-in cards, an alternative message is rendered.
|
1391
|
+
* @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
1392
|
*/
|
1299
1393
|
static attachSigninCard(title: string, url: string, text?: string): Partial<Activity>;
|
1300
1394
|
/**
|
@@ -1302,12 +1396,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1302
1396
|
*
|
1303
1397
|
* @param card A description of the Office 365 connector card.
|
1304
1398
|
* @returns A bot message activity attached with an Office 365 connector card.
|
1399
|
+
* @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
1400
|
*/
|
1306
1401
|
static attachO365ConnectorCard(card: O365ConnectorCard): Partial<Activity>;
|
1307
1402
|
/**
|
1308
1403
|
* Build a message activity attached with a receipt card.
|
1309
1404
|
* @param card A description of the receipt card.
|
1310
1405
|
* @returns A message activity attached with a receipt card.
|
1406
|
+
* @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
1407
|
*/
|
1312
1408
|
static AttachReceiptCard(card: ReceiptCard): Partial<Activity>;
|
1313
1409
|
/**
|
@@ -1318,18 +1414,22 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1318
1414
|
* is converted to an `imBack` button with a title and value set to the value of the string.
|
1319
1415
|
* @param other Optional. Any additional properties to include on the card.
|
1320
1416
|
* @returns A message activity attached with a thumbnail card
|
1417
|
+
* @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
1418
|
*/
|
1322
1419
|
static attachThumbnailCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<ThumbnailCard>): Partial<Activity>;
|
1323
1420
|
/**
|
1324
1421
|
* Add an attachement to a bot activity.
|
1325
1422
|
* @param attachement The attachment object to attach.
|
1326
1423
|
* @returns A message activity with an attachment.
|
1424
|
+
* @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
1425
|
*/
|
1328
1426
|
static attachContent(attachement: Attachment): Partial<Activity>;
|
1329
1427
|
}
|
1330
1428
|
|
1331
1429
|
/**
|
1332
1430
|
* Token response provided by Teams Bot SSO prompt
|
1431
|
+
*
|
1432
|
+
* @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
1433
|
*/
|
1334
1434
|
export declare interface MessageExtensionTokenResponse {
|
1335
1435
|
/**
|
@@ -1351,6 +1451,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1351
1451
|
|
1352
1452
|
/**
|
1353
1453
|
* The response of a message action, e.g., `sendMessage`, `sendAdaptiveCard`.
|
1454
|
+
* @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
1455
|
*/
|
1355
1456
|
declare interface MessageResponse {
|
1356
1457
|
/**
|
@@ -1361,6 +1462,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1361
1462
|
|
1362
1463
|
/**
|
1363
1464
|
* Provide utilities to send notification to varies targets (e.g., member, group, channel).
|
1465
|
+
*
|
1466
|
+
* @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
1467
|
*/
|
1365
1468
|
declare class NotificationBot {
|
1366
1469
|
private readonly conversationReferenceStore;
|
@@ -1459,6 +1562,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1459
1562
|
|
1460
1563
|
/**
|
1461
1564
|
* Options to initialize {@link NotificationBot}.
|
1565
|
+
*
|
1566
|
+
* @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
1567
|
*/
|
1463
1568
|
declare interface NotificationOptions_2 {
|
1464
1569
|
/**
|
@@ -1484,6 +1589,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1484
1589
|
|
1485
1590
|
/**
|
1486
1591
|
* Represent a notification target.
|
1592
|
+
* @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
1593
|
*/
|
1488
1594
|
export declare interface NotificationTarget {
|
1489
1595
|
/**
|
@@ -1519,6 +1625,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1519
1625
|
* - "Channel" means to a team channel. (By default, notification to a team will be sent to its "General" channel.)
|
1520
1626
|
* - "Group" means to a group chat.
|
1521
1627
|
* - "Person" means to a personal chat.
|
1628
|
+
* @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
1629
|
*/
|
1523
1630
|
export declare enum NotificationTargetType {
|
1524
1631
|
/**
|
@@ -1538,6 +1645,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1538
1645
|
|
1539
1646
|
/**
|
1540
1647
|
* Authentication configuration for OnBehalfOfCredential used in node environment
|
1648
|
+
*
|
1649
|
+
* @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
1650
|
*/
|
1542
1651
|
export declare type OnBehalfOfCredentialAuthConfig = {
|
1543
1652
|
/**
|
@@ -1573,6 +1682,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1573
1682
|
/**
|
1574
1683
|
* Represent on-behalf-of flow to get user identity, and it is designed to be used in server side.
|
1575
1684
|
*
|
1685
|
+
* @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
1686
|
* @example
|
1577
1687
|
* ```typescript
|
1578
1688
|
* const credential = new OnBehalfOfUserCredential(ssoToken);
|
@@ -1587,6 +1697,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1587
1697
|
/**
|
1588
1698
|
* Constructor of OnBehalfOfUserCredential
|
1589
1699
|
*
|
1700
|
+
* @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
1701
|
* @remarks
|
1591
1702
|
* Only works in in server side.
|
1592
1703
|
*
|
@@ -1601,6 +1712,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1601
1712
|
/**
|
1602
1713
|
* Get access token from credential.
|
1603
1714
|
*
|
1715
|
+
* @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
1716
|
* @example
|
1605
1717
|
* ```typescript
|
1606
1718
|
* await credential.getToken([]) // Get SSO token using empty string array
|
@@ -1651,6 +1763,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1651
1763
|
|
1652
1764
|
/**
|
1653
1765
|
* Represents a page of data.
|
1766
|
+
* @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
1767
|
*/
|
1655
1768
|
export declare interface PagedData<T> {
|
1656
1769
|
/**
|
@@ -1670,6 +1783,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1670
1783
|
* The search scope when calling {@link NotificationBot.findMember} and {@link NotificationBot.findAllMembers}.
|
1671
1784
|
* The search scope is a flagged enum and it can be combined with `|`.
|
1672
1785
|
* For example, to search from personal chat and group chat, use `SearchScope.Person | SearchScope.Group`.
|
1786
|
+
*
|
1787
|
+
* @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
1788
|
*/
|
1674
1789
|
declare enum SearchScope {
|
1675
1790
|
/**
|
@@ -1693,6 +1808,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1693
1808
|
/**
|
1694
1809
|
* Send an adaptive card message to a notification target.
|
1695
1810
|
*
|
1811
|
+
* @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
1812
|
* @param target - The notification target.
|
1697
1813
|
* @param card - The adaptive card raw JSON.
|
1698
1814
|
* @param onError - An optional error handler that can catch exceptions during adaptive card sending.
|
@@ -1705,6 +1821,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1705
1821
|
/**
|
1706
1822
|
* Send a plain text message to a notification target.
|
1707
1823
|
*
|
1824
|
+
* @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
1825
|
* @param target - The notification target.
|
1709
1826
|
* @param text - The plain text message.
|
1710
1827
|
* @param onError - An optional error handler that can catch exceptions during message sending.
|
@@ -1717,6 +1834,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1717
1834
|
/**
|
1718
1835
|
* Set custom log function. Use the function if it's set. Priority is lower than setLogger.
|
1719
1836
|
*
|
1837
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1838
|
+
*
|
1720
1839
|
* @param {LogFunction} logFunction - custom log function. If it's undefined, custom log function will be cleared.
|
1721
1840
|
*
|
1722
1841
|
* @example
|
@@ -1733,6 +1852,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1733
1852
|
/**
|
1734
1853
|
* Set custom logger. Use the output functions if it's set. Priority is higher than setLogFunction.
|
1735
1854
|
*
|
1855
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1856
|
+
*
|
1736
1857
|
* @param {Logger} logger - custom logger. If it's undefined, custom logger will be cleared.
|
1737
1858
|
*
|
1738
1859
|
* @example
|
@@ -1750,6 +1871,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1750
1871
|
/**
|
1751
1872
|
* Update log level helper.
|
1752
1873
|
*
|
1874
|
+
* @deprecated This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead.
|
1875
|
+
*
|
1753
1876
|
* @param { LogLevel } level - log level in configuration
|
1754
1877
|
*/
|
1755
1878
|
export declare function setLogLevel(level: LogLevel): void;
|
@@ -1760,6 +1883,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1760
1883
|
* - Group chat
|
1761
1884
|
* - Team (by default the `General` channel)
|
1762
1885
|
*
|
1886
|
+
* @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
1887
|
* @remarks
|
1764
1888
|
* It's recommended to get bot installations from {@link ConversationBot.installations()}.
|
1765
1889
|
*/
|
@@ -1885,6 +2009,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1885
2009
|
* }
|
1886
2010
|
* ]));
|
1887
2011
|
* ```
|
2012
|
+
* @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
2013
|
*/
|
1889
2014
|
export declare class TeamsBotSsoPrompt extends Dialog {
|
1890
2015
|
private authConfig;
|
@@ -1900,6 +2025,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1900
2025
|
*
|
1901
2026
|
* @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
|
1902
2027
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
2028
|
+
* @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
2029
|
*/
|
1904
2030
|
constructor(authConfig: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, dialogId: string, settings: TeamsBotSsoPromptSettings);
|
1905
2031
|
/**
|
@@ -1915,6 +2041,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1915
2041
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
1916
2042
|
*
|
1917
2043
|
* @returns A `Promise` representing the asynchronous operation.
|
2044
|
+
* @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
2045
|
*/
|
1919
2046
|
beginDialog(dc: DialogContext): Promise<DialogTurnResult>;
|
1920
2047
|
/**
|
@@ -1932,6 +2059,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1932
2059
|
*
|
1933
2060
|
* @throws {@link ErrorCode|ChannelNotSupported} when bot channel is not MS Teams.
|
1934
2061
|
* @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
|
2062
|
+
* @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
2063
|
*/
|
1936
2064
|
continueDialog(dc: DialogContext): Promise<DialogTurnResult>;
|
1937
2065
|
/**
|
@@ -1980,6 +2108,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
1980
2108
|
|
1981
2109
|
/**
|
1982
2110
|
* Settings used to configure an TeamsBotSsoPrompt instance.
|
2111
|
+
* @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
2112
|
*/
|
1984
2113
|
export declare interface TeamsBotSsoPromptSettings {
|
1985
2114
|
/**
|
@@ -2002,6 +2131,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2002
2131
|
|
2003
2132
|
/**
|
2004
2133
|
* Token response provided by Teams Bot SSO prompt
|
2134
|
+
* @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
2135
|
*/
|
2006
2136
|
export declare interface TeamsBotSsoPromptTokenResponse {
|
2007
2137
|
/**
|
@@ -2023,6 +2153,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2023
2153
|
|
2024
2154
|
/**
|
2025
2155
|
* Interface for adaptive card action handler that can process card action invoke and return a response.
|
2156
|
+
* @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
2157
|
*/
|
2027
2158
|
export declare interface TeamsFxAdaptiveCardActionHandler {
|
2028
2159
|
/**
|
@@ -2064,6 +2195,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2064
2195
|
|
2065
2196
|
/**
|
2066
2197
|
* Interface for a command handler that can process command to a TeamsFx bot and return a response.
|
2198
|
+
* @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
2199
|
*/
|
2068
2200
|
export declare interface TeamsFxBotCommandHandler {
|
2069
2201
|
/**
|
@@ -2083,6 +2215,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2083
2215
|
|
2084
2216
|
/**
|
2085
2217
|
* Interface for a command handler that can process sso command to a TeamsFx bot and return a response.
|
2218
|
+
* @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
2219
|
*/
|
2087
2220
|
export declare interface TeamsFxBotSsoCommandHandler {
|
2088
2221
|
/**
|
@@ -2104,12 +2237,15 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2104
2237
|
/**
|
2105
2238
|
* Represent Teams current user's identity, and it is used within Teams client applications.
|
2106
2239
|
*
|
2240
|
+
* @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
2241
|
* @remarks
|
2108
2242
|
* Can only be used within Teams.
|
2109
2243
|
*/
|
2110
2244
|
export declare class TeamsUserCredential implements TokenCredential {
|
2111
2245
|
/**
|
2112
2246
|
* Constructor of TeamsUserCredential.
|
2247
|
+
*
|
2248
|
+
* @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
2249
|
* @remarks
|
2114
2250
|
* Can only be used within Teams.
|
2115
2251
|
*/
|
@@ -2117,6 +2253,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2117
2253
|
/**
|
2118
2254
|
* Popup login page to get user's access token with specific scopes.
|
2119
2255
|
*
|
2256
|
+
* @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
2257
|
* @param {string[]} resources - The optional list of resources for full trust Teams apps.
|
2121
2258
|
*
|
2122
2259
|
* @remarks
|
@@ -2125,6 +2262,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2125
2262
|
login(scopes: string | string[], resources?: string[]): Promise<void>;
|
2126
2263
|
/**
|
2127
2264
|
* Get access token from credential.
|
2265
|
+
*
|
2266
|
+
* @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
2267
|
* @remarks
|
2129
2268
|
* Can only be used within Teams.
|
2130
2269
|
*/
|
@@ -2132,6 +2271,7 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2132
2271
|
/**
|
2133
2272
|
* Get basic user info from SSO token
|
2134
2273
|
*
|
2274
|
+
* @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
2275
|
* @param {string[]} resources - The optional list of resources for full trust Teams apps.
|
2136
2276
|
*
|
2137
2277
|
* @remarks
|
@@ -2142,6 +2282,8 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2142
2282
|
|
2143
2283
|
/**
|
2144
2284
|
* Authentication configuration for TeamsUserCredential used in browser environment
|
2285
|
+
*
|
2286
|
+
* @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
2287
|
*/
|
2146
2288
|
export declare type TeamsUserCredentialAuthConfig = {
|
2147
2289
|
/**
|
@@ -2156,11 +2298,14 @@ export declare class ApiKeyProvider implements AuthProvider {
|
|
2156
2298
|
|
2157
2299
|
/**
|
2158
2300
|
* The trigger pattern used to trigger a {@link TeamsFxBotCommandHandler} instance.
|
2301
|
+
* @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
2302
|
*/
|
2160
2303
|
export declare type TriggerPatterns = string | RegExp | (string | RegExp)[];
|
2161
2304
|
|
2162
2305
|
/**
|
2163
2306
|
* UserInfo with user displayName, objectId and preferredUserName.
|
2307
|
+
*
|
2308
|
+
* @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
2309
|
*/
|
2165
2310
|
export declare interface UserInfo {
|
2166
2311
|
/**
|