@microsoft/app-manifest 1.0.0-alpha.0d2dd4439.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.
Files changed (106) hide show
  1. package/LICENSE +23 -0
  2. package/README.md +115 -0
  3. package/build/ManifestCommonProperties.d.ts +30 -0
  4. package/build/ManifestCommonProperties.js +5 -0
  5. package/build/ManifestCommonProperties.js.map +1 -0
  6. package/build/constants.d.ts +1 -0
  7. package/build/constants.js +7 -0
  8. package/build/constants.js.map +1 -0
  9. package/build/declarativeCopilotManifest.d.ts +67 -0
  10. package/build/declarativeCopilotManifest.js +15 -0
  11. package/build/declarativeCopilotManifest.js.map +1 -0
  12. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D0.d.ts +163 -0
  13. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D0.js +214 -0
  14. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D0.js.map +1 -0
  15. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D2.d.ts +185 -0
  16. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D2.js +220 -0
  17. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D2.js.map +1 -0
  18. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D3.d.ts +285 -0
  19. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D3.js +248 -0
  20. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D3.js.map +1 -0
  21. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D4.d.ts +292 -0
  22. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D4.js +259 -0
  23. package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D4.js.map +1 -0
  24. package/build/generated-types/copilot/plugin/ApiPluginManifestV2D1.d.ts +429 -0
  25. package/build/generated-types/copilot/plugin/ApiPluginManifestV2D1.js +289 -0
  26. package/build/generated-types/copilot/plugin/ApiPluginManifestV2D1.js.map +1 -0
  27. package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.d.ts +439 -0
  28. package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.js +298 -0
  29. package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.js.map +1 -0
  30. package/build/generated-types/index.d.ts +174 -0
  31. package/build/generated-types/index.js +444 -0
  32. package/build/generated-types/index.js.map +1 -0
  33. package/build/generated-types/teams/TeamsManifestV1D0.d.ts +268 -0
  34. package/build/generated-types/teams/TeamsManifestV1D0.js +265 -0
  35. package/build/generated-types/teams/TeamsManifestV1D0.js.map +1 -0
  36. package/build/generated-types/teams/TeamsManifestV1D1.d.ts +268 -0
  37. package/build/generated-types/teams/TeamsManifestV1D1.js +266 -0
  38. package/build/generated-types/teams/TeamsManifestV1D1.js.map +1 -0
  39. package/build/generated-types/teams/TeamsManifestV1D10.d.ts +589 -0
  40. package/build/generated-types/teams/TeamsManifestV1D10.js +448 -0
  41. package/build/generated-types/teams/TeamsManifestV1D10.js.map +1 -0
  42. package/build/generated-types/teams/TeamsManifestV1D11.d.ts +603 -0
  43. package/build/generated-types/teams/TeamsManifestV1D11.js +447 -0
  44. package/build/generated-types/teams/TeamsManifestV1D11.js.map +1 -0
  45. package/build/generated-types/teams/TeamsManifestV1D12.d.ts +638 -0
  46. package/build/generated-types/teams/TeamsManifestV1D12.js +461 -0
  47. package/build/generated-types/teams/TeamsManifestV1D12.js.map +1 -0
  48. package/build/generated-types/teams/TeamsManifestV1D13.d.ts +640 -0
  49. package/build/generated-types/teams/TeamsManifestV1D13.js +461 -0
  50. package/build/generated-types/teams/TeamsManifestV1D13.js.map +1 -0
  51. package/build/generated-types/teams/TeamsManifestV1D14.d.ts +651 -0
  52. package/build/generated-types/teams/TeamsManifestV1D14.js +467 -0
  53. package/build/generated-types/teams/TeamsManifestV1D14.js.map +1 -0
  54. package/build/generated-types/teams/TeamsManifestV1D15.d.ts +656 -0
  55. package/build/generated-types/teams/TeamsManifestV1D15.js +468 -0
  56. package/build/generated-types/teams/TeamsManifestV1D15.js.map +1 -0
  57. package/build/generated-types/teams/TeamsManifestV1D16.d.ts +659 -0
  58. package/build/generated-types/teams/TeamsManifestV1D16.js +471 -0
  59. package/build/generated-types/teams/TeamsManifestV1D16.js.map +1 -0
  60. package/build/generated-types/teams/TeamsManifestV1D17.d.ts +1212 -0
  61. package/build/generated-types/teams/TeamsManifestV1D17.js +733 -0
  62. package/build/generated-types/teams/TeamsManifestV1D17.js.map +1 -0
  63. package/build/generated-types/teams/TeamsManifestV1D19.d.ts +1238 -0
  64. package/build/generated-types/teams/TeamsManifestV1D19.js +742 -0
  65. package/build/generated-types/teams/TeamsManifestV1D19.js.map +1 -0
  66. package/build/generated-types/teams/TeamsManifestV1D2.d.ts +268 -0
  67. package/build/generated-types/teams/TeamsManifestV1D2.js +266 -0
  68. package/build/generated-types/teams/TeamsManifestV1D2.js.map +1 -0
  69. package/build/generated-types/teams/TeamsManifestV1D20.d.ts +1420 -0
  70. package/build/generated-types/teams/TeamsManifestV1D20.js +818 -0
  71. package/build/generated-types/teams/TeamsManifestV1D20.js.map +1 -0
  72. package/build/generated-types/teams/TeamsManifestV1D3.d.ts +280 -0
  73. package/build/generated-types/teams/TeamsManifestV1D3.js +279 -0
  74. package/build/generated-types/teams/TeamsManifestV1D3.js.map +1 -0
  75. package/build/generated-types/teams/TeamsManifestV1D4.d.ts +333 -0
  76. package/build/generated-types/teams/TeamsManifestV1D4.js +316 -0
  77. package/build/generated-types/teams/TeamsManifestV1D4.js.map +1 -0
  78. package/build/generated-types/teams/TeamsManifestV1D5.d.ts +423 -0
  79. package/build/generated-types/teams/TeamsManifestV1D5.js +357 -0
  80. package/build/generated-types/teams/TeamsManifestV1D5.js.map +1 -0
  81. package/build/generated-types/teams/TeamsManifestV1D6.d.ts +428 -0
  82. package/build/generated-types/teams/TeamsManifestV1D6.js +359 -0
  83. package/build/generated-types/teams/TeamsManifestV1D6.js.map +1 -0
  84. package/build/generated-types/teams/TeamsManifestV1D7.d.ts +444 -0
  85. package/build/generated-types/teams/TeamsManifestV1D7.js +369 -0
  86. package/build/generated-types/teams/TeamsManifestV1D7.js.map +1 -0
  87. package/build/generated-types/teams/TeamsManifestV1D8.d.ts +466 -0
  88. package/build/generated-types/teams/TeamsManifestV1D8.js +386 -0
  89. package/build/generated-types/teams/TeamsManifestV1D8.js.map +1 -0
  90. package/build/generated-types/teams/TeamsManifestV1D9.d.ts +532 -0
  91. package/build/generated-types/teams/TeamsManifestV1D9.js +420 -0
  92. package/build/generated-types/teams/TeamsManifestV1D9.js.map +1 -0
  93. package/build/generated-types/teams/TeamsManifestVDevPreview.d.ts +2219 -0
  94. package/build/generated-types/teams/TeamsManifestVDevPreview.js +1090 -0
  95. package/build/generated-types/teams/TeamsManifestVDevPreview.js.map +1 -0
  96. package/build/index.d.ts +88 -0
  97. package/build/index.js +247 -0
  98. package/build/index.js.map +1 -0
  99. package/build/manifest.d.ts +521 -0
  100. package/build/manifest.js +61 -0
  101. package/build/manifest.js.map +1 -0
  102. package/build/pluginManifest.d.ts +143 -0
  103. package/build/pluginManifest.js +3 -0
  104. package/build/pluginManifest.js.map +1 -0
  105. package/build/tsconfig.tsbuildinfo +1 -0
  106. package/package.json +68 -0
@@ -0,0 +1,444 @@
1
+ export interface TeamsManifestV1D7 {
2
+ $schema?: string;
3
+ /**
4
+ * The version of the schema this manifest is using.
5
+ */
6
+ manifestVersion: "1.7";
7
+ /**
8
+ * The version of the app. Changes to your manifest should cause a version change. This
9
+ * version string must follow the semver standard (http://semver.org).
10
+ */
11
+ version: string;
12
+ /**
13
+ * A unique identifier for this app. This id must be a GUID.
14
+ */
15
+ id: string;
16
+ /**
17
+ * A unique identifier for this app in reverse domain notation. E.g: com.example.myapp
18
+ */
19
+ packageName?: string;
20
+ localizationInfo?: LocalizationInfo;
21
+ developer: Developer;
22
+ name: Name;
23
+ description: Description;
24
+ icons: Icons;
25
+ /**
26
+ * A color to use in conjunction with the icon. The value must be a valid HTML color code
27
+ * starting with '#', for example `#4464ee`.
28
+ */
29
+ accentColor: string;
30
+ /**
31
+ * These are tabs users can optionally add to their channels and 1:1 or group chats and
32
+ * require extra configuration before they are added. Configurable tabs are not supported in
33
+ * the personal scope. Currently only one configurable tab per app is supported.
34
+ */
35
+ configurableTabs?: ConfigurableTab[];
36
+ /**
37
+ * A set of tabs that may be 'pinned' by default, without the user adding them manually.
38
+ * Static tabs declared in personal scope are always pinned to the app's personal
39
+ * experience. Static tabs do not currently support the 'teams' scope.
40
+ */
41
+ staticTabs?: StaticTab[];
42
+ /**
43
+ * The set of bots for this app. Currently only one bot per app is supported.
44
+ */
45
+ bots?: Bot[];
46
+ /**
47
+ * The set of Office365 connectors for this app. Currently only one connector per app is
48
+ * supported.
49
+ */
50
+ connectors?: Connector[];
51
+ /**
52
+ * The set of compose extensions for this app. Currently only one compose extension per app
53
+ * is supported.
54
+ */
55
+ composeExtensions?: ComposeExtension[];
56
+ /**
57
+ * Specifies the permissions the app requests from users.
58
+ */
59
+ permissions?: Permission[];
60
+ /**
61
+ * Specify the native features on a user's device that your app may request access to.
62
+ */
63
+ devicePermissions?: DevicePermission[];
64
+ /**
65
+ * A list of valid domains from which the tabs expect to load any content. Domain listings
66
+ * can include wildcards, for example `*.example.com`. If your tab configuration or content
67
+ * UI needs to navigate to any other domain besides the one use for tab configuration, that
68
+ * domain must be specified here.
69
+ */
70
+ validDomains?: string[];
71
+ /**
72
+ * Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
73
+ * app.
74
+ */
75
+ webApplicationInfo?: WebApplicationInfo;
76
+ /**
77
+ * A value indicating whether or not show loading indicator when app/tab is loading
78
+ */
79
+ showLoadingIndicator?: boolean;
80
+ /**
81
+ * A value indicating whether a personal app is rendered without a tab header-bar
82
+ */
83
+ isFullScreen?: boolean;
84
+ activities?: Activities;
85
+ }
86
+ export interface Activities {
87
+ /**
88
+ * Specify the types of activites that your app can post to a users activity feed
89
+ */
90
+ activityTypes?: ActivityType[];
91
+ }
92
+ export interface ActivityType {
93
+ type: string;
94
+ description: string;
95
+ templateText: string;
96
+ }
97
+ export interface Bot {
98
+ /**
99
+ * The Microsoft App ID specified for the bot in the Bot Framework portal
100
+ * (https://dev.botframework.com/bots)
101
+ */
102
+ botId: string;
103
+ /**
104
+ * This value describes whether or not the bot utilizes a user hint to add the bot to a
105
+ * specific channel.
106
+ */
107
+ needsChannelSelector?: boolean;
108
+ /**
109
+ * A value indicating whether or not the bot is a one-way notification only bot, as opposed
110
+ * to a conversational bot.
111
+ */
112
+ isNotificationOnly?: boolean;
113
+ /**
114
+ * A value indicating whether the bot supports uploading/downloading of files.
115
+ */
116
+ supportsFiles?: boolean;
117
+ /**
118
+ * Specifies whether the bot offers an experience in the context of a channel in a team, in
119
+ * a 1:1 or group chat, or in an experience scoped to an individual user alone. These
120
+ * options are non-exclusive.
121
+ */
122
+ scopes: CommandListScope[];
123
+ /**
124
+ * The list of commands that the bot supplies, including their usage, description, and the
125
+ * scope for which the commands are valid. A separate command list should be used for each
126
+ * scope.
127
+ */
128
+ commandLists?: CommandList[];
129
+ }
130
+ export interface CommandList {
131
+ /**
132
+ * Specifies the scopes for which the command list is valid
133
+ */
134
+ scopes: CommandListScope[];
135
+ commands: CommandListCommand[];
136
+ }
137
+ export interface CommandListCommand {
138
+ /**
139
+ * The bot command name
140
+ */
141
+ title: string;
142
+ /**
143
+ * A simple text description or an example of the command syntax and its arguments.
144
+ */
145
+ description: string;
146
+ }
147
+ export type CommandListScope = "team" | "personal" | "groupChat" | "groupchat";
148
+ export interface ComposeExtension {
149
+ /**
150
+ * The Microsoft App ID specified for the bot powering the compose extension in the Bot
151
+ * Framework portal (https://dev.botframework.com/bots)
152
+ */
153
+ botId: string;
154
+ /**
155
+ * A value indicating whether the configuration of a compose extension can be updated by the
156
+ * user.
157
+ */
158
+ canUpdateConfiguration?: boolean;
159
+ commands: ComposeExtensionCommand[];
160
+ /**
161
+ * A list of handlers that allow apps to be invoked when certain conditions are met
162
+ */
163
+ messageHandlers?: MessageHandler[];
164
+ }
165
+ export interface ComposeExtensionCommand {
166
+ /**
167
+ * Id of the command.
168
+ */
169
+ id: string;
170
+ /**
171
+ * Type of the command
172
+ */
173
+ type?: CommandType;
174
+ /**
175
+ * Context where the command would apply
176
+ */
177
+ context?: Context[];
178
+ /**
179
+ * Title of the command.
180
+ */
181
+ title: string;
182
+ /**
183
+ * Description of the command.
184
+ */
185
+ description?: string;
186
+ /**
187
+ * A boolean value that indicates if the command should be run once initially with no
188
+ * parameter.
189
+ */
190
+ initialRun?: boolean;
191
+ /**
192
+ * A boolean value that indicates if it should fetch task module dynamically
193
+ */
194
+ fetchTask?: boolean;
195
+ parameters?: Parameter[];
196
+ taskInfo?: TaskInfo;
197
+ }
198
+ export type Context = "compose" | "commandBox" | "message";
199
+ export interface Parameter {
200
+ /**
201
+ * Name of the parameter.
202
+ */
203
+ name: string;
204
+ /**
205
+ * Type of the parameter
206
+ */
207
+ inputType?: InputType;
208
+ /**
209
+ * Title of the parameter.
210
+ */
211
+ title: string;
212
+ /**
213
+ * Description of the parameter.
214
+ */
215
+ description?: string;
216
+ /**
217
+ * Initial value for the parameter
218
+ */
219
+ value?: string;
220
+ /**
221
+ * The choice options for the parameter
222
+ */
223
+ choices?: Choice[];
224
+ }
225
+ export interface Choice {
226
+ /**
227
+ * Title of the choice
228
+ */
229
+ title: string;
230
+ /**
231
+ * Value of the choice
232
+ */
233
+ value: string;
234
+ }
235
+ /**
236
+ * Type of the parameter
237
+ */
238
+ export type InputType = "text" | "textarea" | "number" | "date" | "time" | "toggle" | "choiceset";
239
+ export interface TaskInfo {
240
+ /**
241
+ * Initial dialog title
242
+ */
243
+ title?: string;
244
+ /**
245
+ * Dialog width - either a number in pixels or default layout such as 'large', 'medium', or
246
+ * 'small'
247
+ */
248
+ width?: string;
249
+ /**
250
+ * Dialog height - either a number in pixels or default layout such as 'large', 'medium', or
251
+ * 'small'
252
+ */
253
+ height?: string;
254
+ /**
255
+ * Initial webview URL
256
+ */
257
+ url?: string;
258
+ }
259
+ /**
260
+ * Type of the command
261
+ */
262
+ export type CommandType = "query" | "action";
263
+ export interface MessageHandler {
264
+ /**
265
+ * Type of the message handler
266
+ */
267
+ type: "link";
268
+ value: Value;
269
+ }
270
+ /**
271
+ * Type of the message handler
272
+ */
273
+ export interface Value {
274
+ /**
275
+ * A list of domains that the link message handler can register for, and when they are
276
+ * matched the app will be invoked
277
+ */
278
+ domains?: string[];
279
+ [property: string]: any;
280
+ }
281
+ export interface ConfigurableTab {
282
+ /**
283
+ * The url to use when configuring the tab.
284
+ */
285
+ configurationUrl: string;
286
+ /**
287
+ * A value indicating whether an instance of the tab's configuration can be updated by the
288
+ * user after creation.
289
+ */
290
+ canUpdateConfiguration?: boolean;
291
+ /**
292
+ * Specifies whether the tab offers an experience in the context of a channel in a team, in
293
+ * a 1:1 or group chat, or in an experience scoped to an individual user alone. These
294
+ * options are non-exclusive. Currently, configurable tabs are only supported in the teams
295
+ * and groupchats scopes.
296
+ */
297
+ scopes: ConfigurableTabScope[];
298
+ /**
299
+ * A relative file path to a tab preview image for use in SharePoint. Size 1024x768.
300
+ */
301
+ sharePointPreviewImage?: string;
302
+ /**
303
+ * Defines how your tab will be made available in SharePoint.
304
+ */
305
+ supportedSharePointHosts?: SupportedSharePointHost[];
306
+ }
307
+ export type ConfigurableTabScope = "team" | "groupChat" | "groupchat";
308
+ export type SupportedSharePointHost = "sharePointFullPage" | "sharePointWebPart";
309
+ export interface Connector {
310
+ /**
311
+ * A unique identifier for the connector which matches its ID in the Connectors Developer
312
+ * Portal.
313
+ */
314
+ connectorId: string;
315
+ /**
316
+ * The url to use for configuring the connector using the inline configuration experience.
317
+ */
318
+ configurationUrl?: string;
319
+ /**
320
+ * Specifies whether the connector offers an experience in the context of a channel in a
321
+ * team, or an experience scoped to an individual user alone. Currently, only the team scope
322
+ * is supported.
323
+ */
324
+ scopes: "team"[];
325
+ }
326
+ export interface Description {
327
+ /**
328
+ * A short description of the app used when space is limited. Maximum length is 80
329
+ * characters.
330
+ */
331
+ short: string;
332
+ /**
333
+ * The full description of the app. Maximum length is 4000 characters.
334
+ */
335
+ full: string;
336
+ }
337
+ export interface Developer {
338
+ /**
339
+ * The display name for the developer.
340
+ */
341
+ name: string;
342
+ /**
343
+ * The Microsoft Partner Network ID that identifies the partner organization building the
344
+ * app. This field is not required, and should only be used if you are already part of the
345
+ * Microsoft Partner Network. More info at https://aka.ms/partner
346
+ */
347
+ mpnId?: string;
348
+ /**
349
+ * The url to the page that provides support information for the app.
350
+ */
351
+ websiteUrl: string;
352
+ /**
353
+ * The url to the page that provides privacy information for the app.
354
+ */
355
+ privacyUrl: string;
356
+ /**
357
+ * The url to the page that provides the terms of use for the app.
358
+ */
359
+ termsOfUseUrl: string;
360
+ }
361
+ export type DevicePermission = "geolocation" | "media" | "notifications" | "midi" | "openExternal";
362
+ export interface Icons {
363
+ /**
364
+ * A relative file path to a transparent PNG outline icon. The border color needs to be
365
+ * white. Size 32x32.
366
+ */
367
+ outline: string;
368
+ /**
369
+ * A relative file path to a full color PNG icon. Size 192x192.
370
+ */
371
+ color: string;
372
+ }
373
+ export interface LocalizationInfo {
374
+ /**
375
+ * The language tag of the strings in this top level manifest file.
376
+ */
377
+ defaultLanguageTag: string;
378
+ additionalLanguages?: AdditionalLanguage[];
379
+ }
380
+ export interface AdditionalLanguage {
381
+ /**
382
+ * The language tag of the strings in the provided file.
383
+ */
384
+ languageTag: string;
385
+ /**
386
+ * A relative file path to a the .json file containing the translated strings.
387
+ */
388
+ file: string;
389
+ }
390
+ export interface Name {
391
+ /**
392
+ * A short display name for the app.
393
+ */
394
+ short: string;
395
+ /**
396
+ * The full name of the app, used if the full app name exceeds 30 characters.
397
+ */
398
+ full?: string;
399
+ }
400
+ export type Permission = "identity" | "messageTeamMembers";
401
+ export interface StaticTab {
402
+ /**
403
+ * A unique identifier for the entity which the tab displays.
404
+ */
405
+ entityId: string;
406
+ /**
407
+ * The display name of the tab.
408
+ */
409
+ name?: string;
410
+ /**
411
+ * The url which points to the entity UI to be displayed in the Teams canvas.
412
+ */
413
+ contentUrl?: string;
414
+ /**
415
+ * The url to point at if a user opts to view in a browser.
416
+ */
417
+ websiteUrl?: string;
418
+ /**
419
+ * Specifies whether the tab offers an experience in the context of a channel in a team, or
420
+ * an experience scoped to an individual user alone. These options are non-exclusive.
421
+ * Currently static tabs are only supported in the 'personal' scope.
422
+ */
423
+ scopes: StaticTabScope[];
424
+ }
425
+ export type StaticTabScope = "team" | "personal";
426
+ /**
427
+ * Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
428
+ * app.
429
+ */
430
+ export interface WebApplicationInfo {
431
+ /**
432
+ * AAD application id of the app. This id must be a GUID.
433
+ */
434
+ id: string;
435
+ /**
436
+ * Resource url of app for acquiring auth token for SSO.
437
+ */
438
+ resource?: string;
439
+ applicationPermissions?: string[];
440
+ }
441
+ export declare class Convert {
442
+ static toTeamsManifestV1D7(json: string): TeamsManifestV1D7;
443
+ static teamsManifestV1D7ToJson(value: TeamsManifestV1D7): string;
444
+ }