@microsoft/agents-activity 1.6.0-beta.19.gbf5e38f582 → 1.6.0-beta.20.gabdeae0c72

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.
@@ -7,50 +7,77 @@ import { Entity } from './entity';
7
7
  /**
8
8
  * Supported icon names for client citations. These icons are displayed in Teams to help users
9
9
  * identify the type of content being referenced in AI-generated responses.
10
+ *
11
+ * The set of allowed values is defined by the
12
+ * [Add citations](https://learn.microsoft.com/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=desktop%2Cjs%2Cbotmessage#add-citations)
13
+ * section of the Microsoft Teams documentation (property `citation.appearance.image.name`).
14
+ *
15
+ * `ClientCitationIconName` is both a value (a frozen object with named members, e.g.
16
+ * `ClientCitationIconName.MicrosoftWord`) and a type alias (the string-literal union of all
17
+ * supported icon names). Either form may be assigned to `citation.appearance.image.name`.
18
+ *
19
+ * @example
20
+ * ```typescript
21
+ * const citation: ClientCitation = {
22
+ * '@type': 'Claim',
23
+ * position: 1,
24
+ * appearance: {
25
+ * '@type': 'DigitalDocument',
26
+ * name: 'Quarterly report',
27
+ * abstract: 'Q1 results',
28
+ * image: { '@type': 'ImageObject', name: ClientCitationIconName.MicrosoftWord }
29
+ * }
30
+ * }
31
+ * ```
32
+ */
33
+ export declare const ClientCitationIconName: {
34
+ /** Microsoft Word document icon */
35
+ readonly MicrosoftWord: "Microsoft Word";
36
+ /** Microsoft Excel spreadsheet icon */
37
+ readonly MicrosoftExcel: "Microsoft Excel";
38
+ /** Microsoft PowerPoint presentation icon */
39
+ readonly MicrosoftPowerPoint: "Microsoft PowerPoint";
40
+ /** Microsoft OneNote notebook icon */
41
+ readonly MicrosoftOneNote: "Microsoft OneNote";
42
+ /** Microsoft SharePoint site or document icon */
43
+ readonly MicrosoftSharePoint: "Microsoft SharePoint";
44
+ /** Microsoft Visio diagram icon */
45
+ readonly MicrosoftVisio: "Microsoft Visio";
46
+ /** Microsoft Loop component icon */
47
+ readonly MicrosoftLoop: "Microsoft Loop";
48
+ /** Microsoft Whiteboard icon */
49
+ readonly MicrosoftWhiteboard: "Microsoft Whiteboard";
50
+ /** Adobe Illustrator vector graphics icon */
51
+ readonly AdobeIllustrator: "Adobe Illustrator";
52
+ /** Adobe Photoshop image editing icon */
53
+ readonly AdobePhotoshop: "Adobe Photoshop";
54
+ /** Adobe InDesign layout design icon */
55
+ readonly AdobeInDesign: "Adobe InDesign";
56
+ /** Adobe Flash multimedia icon */
57
+ readonly AdobeFlash: "Adobe Flash";
58
+ /** Sketch design tool icon */
59
+ readonly Sketch: "Sketch";
60
+ /** Source code file icon */
61
+ readonly SourceCode: "Source Code";
62
+ /** Generic image file icon */
63
+ readonly Image: "Image";
64
+ /** Animated GIF image icon */
65
+ readonly GIF: "GIF";
66
+ /** Video file icon */
67
+ readonly Video: "Video";
68
+ /** Audio/sound file icon */
69
+ readonly Sound: "Sound";
70
+ /** ZIP archive file icon */
71
+ readonly ZIP: "ZIP";
72
+ /** Plain text file icon */
73
+ readonly Text: "Text";
74
+ /** PDF document icon */
75
+ readonly PDF: "PDF";
76
+ };
77
+ /**
78
+ * String-literal union of all supported {@link ClientCitationIconName} values.
10
79
  */
11
- export type ClientCitationIconName =
12
- /** Microsoft Word document icon */
13
- 'Microsoft Word'
14
- /** Microsoft Excel spreadsheet icon */
15
- | 'Microsoft Excel'
16
- /** Microsoft PowerPoint presentation icon */
17
- | 'Microsoft PowerPoint'
18
- /** Microsoft OneNote notebook icon */
19
- | 'Microsoft OneNote'
20
- /** Microsoft SharePoint site or document icon */
21
- | 'Microsoft SharePoint'
22
- /** Microsoft Visio diagram icon */
23
- | 'Microsoft Visio'
24
- /** Microsoft Loop component icon */
25
- | 'Microsoft Loop'
26
- /** Microsoft Whiteboard icon */
27
- | 'Microsoft Whiteboard'
28
- /** Adobe Illustrator vector graphics icon */
29
- | 'Adobe Illustrator'
30
- /** Adobe Photoshop image editing icon */
31
- | 'Adobe Photoshop'
32
- /** Adobe InDesign layout design icon */
33
- | 'Adobe InDesign'
34
- /** Adobe Flash multimedia icon */
35
- | 'Adobe Flash'
36
- /** Sketch design tool icon */
37
- | 'Sketch'
38
- /** Source code file icon */
39
- | 'Source Code'
40
- /** Generic image file icon */
41
- | 'Image'
42
- /** Animated GIF image icon */
43
- | 'GIF'
44
- /** Video file icon */
45
- | 'Video'
46
- /** Audio/sound file icon */
47
- | 'Sound'
48
- /** ZIP archive file icon */
49
- | 'ZIP'
50
- /** Plain text file icon */
51
- | 'Text'
52
- /** PDF document icon */
53
- | 'PDF';
80
+ export type ClientCitationIconName = typeof ClientCitationIconName[keyof typeof ClientCitationIconName];
54
81
  /**
55
82
  * Represents a Teams client citation to be included in a message.
56
83
  *
@@ -4,7 +4,77 @@
4
4
  * Licensed under the MIT License.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.addAIToActivity = void 0;
7
+ exports.addAIToActivity = exports.ClientCitationIconName = void 0;
8
+ /**
9
+ * Supported icon names for client citations. These icons are displayed in Teams to help users
10
+ * identify the type of content being referenced in AI-generated responses.
11
+ *
12
+ * The set of allowed values is defined by the
13
+ * [Add citations](https://learn.microsoft.com/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=desktop%2Cjs%2Cbotmessage#add-citations)
14
+ * section of the Microsoft Teams documentation (property `citation.appearance.image.name`).
15
+ *
16
+ * `ClientCitationIconName` is both a value (a frozen object with named members, e.g.
17
+ * `ClientCitationIconName.MicrosoftWord`) and a type alias (the string-literal union of all
18
+ * supported icon names). Either form may be assigned to `citation.appearance.image.name`.
19
+ *
20
+ * @example
21
+ * ```typescript
22
+ * const citation: ClientCitation = {
23
+ * '@type': 'Claim',
24
+ * position: 1,
25
+ * appearance: {
26
+ * '@type': 'DigitalDocument',
27
+ * name: 'Quarterly report',
28
+ * abstract: 'Q1 results',
29
+ * image: { '@type': 'ImageObject', name: ClientCitationIconName.MicrosoftWord }
30
+ * }
31
+ * }
32
+ * ```
33
+ */
34
+ exports.ClientCitationIconName = {
35
+ /** Microsoft Word document icon */
36
+ MicrosoftWord: 'Microsoft Word',
37
+ /** Microsoft Excel spreadsheet icon */
38
+ MicrosoftExcel: 'Microsoft Excel',
39
+ /** Microsoft PowerPoint presentation icon */
40
+ MicrosoftPowerPoint: 'Microsoft PowerPoint',
41
+ /** Microsoft OneNote notebook icon */
42
+ MicrosoftOneNote: 'Microsoft OneNote',
43
+ /** Microsoft SharePoint site or document icon */
44
+ MicrosoftSharePoint: 'Microsoft SharePoint',
45
+ /** Microsoft Visio diagram icon */
46
+ MicrosoftVisio: 'Microsoft Visio',
47
+ /** Microsoft Loop component icon */
48
+ MicrosoftLoop: 'Microsoft Loop',
49
+ /** Microsoft Whiteboard icon */
50
+ MicrosoftWhiteboard: 'Microsoft Whiteboard',
51
+ /** Adobe Illustrator vector graphics icon */
52
+ AdobeIllustrator: 'Adobe Illustrator',
53
+ /** Adobe Photoshop image editing icon */
54
+ AdobePhotoshop: 'Adobe Photoshop',
55
+ /** Adobe InDesign layout design icon */
56
+ AdobeInDesign: 'Adobe InDesign',
57
+ /** Adobe Flash multimedia icon */
58
+ AdobeFlash: 'Adobe Flash',
59
+ /** Sketch design tool icon */
60
+ Sketch: 'Sketch',
61
+ /** Source code file icon */
62
+ SourceCode: 'Source Code',
63
+ /** Generic image file icon */
64
+ Image: 'Image',
65
+ /** Animated GIF image icon */
66
+ GIF: 'GIF',
67
+ /** Video file icon */
68
+ Video: 'Video',
69
+ /** Audio/sound file icon */
70
+ Sound: 'Sound',
71
+ /** ZIP archive file icon */
72
+ ZIP: 'ZIP',
73
+ /** Plain text file icon */
74
+ Text: 'Text',
75
+ /** PDF document icon */
76
+ PDF: 'PDF'
77
+ };
8
78
  /**
9
79
  * Adds an AI entity to an activity to indicate that the content was generated by AI.
10
80
  *
@@ -1 +1 @@
1
- {"version":3,"file":"AIEntity.js","sourceRoot":"","sources":["../../../src/entity/AIEntity.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA4NH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACI,MAAM,eAAe,GAAG,CAC7B,QAAkB,EAClB,SAA4B,EAC5B,SAAgC,EAC1B,EAAE;;IACR,MAAM,QAAQ,GAAa;QACzB,IAAI,EAAE,4BAA4B;QAClC,OAAO,EAAE,SAAS;QAClB,UAAU,EAAE,oBAAoB;QAChC,KAAK,EAAE,EAAE;QACT,cAAc,EAAE,CAAC,oBAAoB,CAAC;QACtC,QAAQ,EAAE,SAAS;QACnB,SAAS;KACV,CAAA;IACD,MAAA,QAAQ,CAAC,QAAQ,oCAAjB,QAAQ,CAAC,QAAQ,GAAK,EAAE,EAAA;IACxB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;AAClC,CAAC,CAAA;AAhBY,QAAA,eAAe,mBAgB3B"}
1
+ {"version":3,"file":"AIEntity.js","sourceRoot":"","sources":["../../../src/entity/AIEntity.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,sBAAsB,GAAG;IACpC,mCAAmC;IACnC,aAAa,EAAE,gBAAgB;IAC/B,uCAAuC;IACvC,cAAc,EAAE,iBAAiB;IACjC,6CAA6C;IAC7C,mBAAmB,EAAE,sBAAsB;IAC3C,sCAAsC;IACtC,gBAAgB,EAAE,mBAAmB;IACrC,iDAAiD;IACjD,mBAAmB,EAAE,sBAAsB;IAC3C,mCAAmC;IACnC,cAAc,EAAE,iBAAiB;IACjC,oCAAoC;IACpC,aAAa,EAAE,gBAAgB;IAC/B,gCAAgC;IAChC,mBAAmB,EAAE,sBAAsB;IAC3C,6CAA6C;IAC7C,gBAAgB,EAAE,mBAAmB;IACrC,yCAAyC;IACzC,cAAc,EAAE,iBAAiB;IACjC,wCAAwC;IACxC,aAAa,EAAE,gBAAgB;IAC/B,kCAAkC;IAClC,UAAU,EAAE,aAAa;IACzB,8BAA8B;IAC9B,MAAM,EAAE,QAAQ;IAChB,4BAA4B;IAC5B,UAAU,EAAE,aAAa;IACzB,8BAA8B;IAC9B,KAAK,EAAE,OAAO;IACd,8BAA8B;IAC9B,GAAG,EAAE,KAAK;IACV,sBAAsB;IACtB,KAAK,EAAE,OAAO;IACd,4BAA4B;IAC5B,KAAK,EAAE,OAAO;IACd,4BAA4B;IAC5B,GAAG,EAAE,KAAK;IACV,2BAA2B;IAC3B,IAAI,EAAE,MAAM;IACZ,wBAAwB;IACxB,GAAG,EAAE,KAAK;CACF,CAAA;AA+KV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACI,MAAM,eAAe,GAAG,CAC7B,QAAkB,EAClB,SAA4B,EAC5B,SAAgC,EAC1B,EAAE;;IACR,MAAM,QAAQ,GAAa;QACzB,IAAI,EAAE,4BAA4B;QAClC,OAAO,EAAE,SAAS;QAClB,UAAU,EAAE,oBAAoB;QAChC,KAAK,EAAE,EAAE;QACT,cAAc,EAAE,CAAC,oBAAoB,CAAC;QACtC,QAAQ,EAAE,SAAS;QACnB,SAAS;KACV,CAAA;IACD,MAAA,QAAQ,CAAC,QAAQ,oCAAjB,QAAQ,CAAC,QAAQ,GAAK,EAAE,EAAA;IACxB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;AAClC,CAAC,CAAA;AAhBY,QAAA,eAAe,mBAgB3B"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@microsoft/agents-activity",
4
- "version": "1.6.0-beta.19.gbf5e38f582",
4
+ "version": "1.6.0-beta.20.gabdeae0c72",
5
5
  "homepage": "https://github.com/microsoft/Agents-for-js",
6
6
  "repository": {
7
7
  "type": "git",
@@ -9,50 +9,79 @@ import { Entity } from './entity'
9
9
  /**
10
10
  * Supported icon names for client citations. These icons are displayed in Teams to help users
11
11
  * identify the type of content being referenced in AI-generated responses.
12
+ *
13
+ * The set of allowed values is defined by the
14
+ * [Add citations](https://learn.microsoft.com/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=desktop%2Cjs%2Cbotmessage#add-citations)
15
+ * section of the Microsoft Teams documentation (property `citation.appearance.image.name`).
16
+ *
17
+ * `ClientCitationIconName` is both a value (a frozen object with named members, e.g.
18
+ * `ClientCitationIconName.MicrosoftWord`) and a type alias (the string-literal union of all
19
+ * supported icon names). Either form may be assigned to `citation.appearance.image.name`.
20
+ *
21
+ * @example
22
+ * ```typescript
23
+ * const citation: ClientCitation = {
24
+ * '@type': 'Claim',
25
+ * position: 1,
26
+ * appearance: {
27
+ * '@type': 'DigitalDocument',
28
+ * name: 'Quarterly report',
29
+ * abstract: 'Q1 results',
30
+ * image: { '@type': 'ImageObject', name: ClientCitationIconName.MicrosoftWord }
31
+ * }
32
+ * }
33
+ * ```
12
34
  */
13
- export type ClientCitationIconName =
35
+ export const ClientCitationIconName = {
14
36
  /** Microsoft Word document icon */
15
- | 'Microsoft Word'
37
+ MicrosoftWord: 'Microsoft Word',
16
38
  /** Microsoft Excel spreadsheet icon */
17
- | 'Microsoft Excel'
39
+ MicrosoftExcel: 'Microsoft Excel',
18
40
  /** Microsoft PowerPoint presentation icon */
19
- | 'Microsoft PowerPoint'
41
+ MicrosoftPowerPoint: 'Microsoft PowerPoint',
20
42
  /** Microsoft OneNote notebook icon */
21
- | 'Microsoft OneNote'
43
+ MicrosoftOneNote: 'Microsoft OneNote',
22
44
  /** Microsoft SharePoint site or document icon */
23
- | 'Microsoft SharePoint'
45
+ MicrosoftSharePoint: 'Microsoft SharePoint',
24
46
  /** Microsoft Visio diagram icon */
25
- | 'Microsoft Visio'
47
+ MicrosoftVisio: 'Microsoft Visio',
26
48
  /** Microsoft Loop component icon */
27
- | 'Microsoft Loop'
49
+ MicrosoftLoop: 'Microsoft Loop',
28
50
  /** Microsoft Whiteboard icon */
29
- | 'Microsoft Whiteboard'
51
+ MicrosoftWhiteboard: 'Microsoft Whiteboard',
30
52
  /** Adobe Illustrator vector graphics icon */
31
- | 'Adobe Illustrator'
53
+ AdobeIllustrator: 'Adobe Illustrator',
32
54
  /** Adobe Photoshop image editing icon */
33
- | 'Adobe Photoshop'
55
+ AdobePhotoshop: 'Adobe Photoshop',
34
56
  /** Adobe InDesign layout design icon */
35
- | 'Adobe InDesign'
57
+ AdobeInDesign: 'Adobe InDesign',
36
58
  /** Adobe Flash multimedia icon */
37
- | 'Adobe Flash'
59
+ AdobeFlash: 'Adobe Flash',
38
60
  /** Sketch design tool icon */
39
- | 'Sketch'
61
+ Sketch: 'Sketch',
40
62
  /** Source code file icon */
41
- | 'Source Code'
63
+ SourceCode: 'Source Code',
42
64
  /** Generic image file icon */
43
- | 'Image'
65
+ Image: 'Image',
44
66
  /** Animated GIF image icon */
45
- | 'GIF'
67
+ GIF: 'GIF',
46
68
  /** Video file icon */
47
- | 'Video'
69
+ Video: 'Video',
48
70
  /** Audio/sound file icon */
49
- | 'Sound'
71
+ Sound: 'Sound',
50
72
  /** ZIP archive file icon */
51
- | 'ZIP'
73
+ ZIP: 'ZIP',
52
74
  /** Plain text file icon */
53
- | 'Text'
75
+ Text: 'Text',
54
76
  /** PDF document icon */
55
- | 'PDF'
77
+ PDF: 'PDF'
78
+ } as const
79
+
80
+ /**
81
+ * String-literal union of all supported {@link ClientCitationIconName} values.
82
+ */
83
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
84
+ export type ClientCitationIconName = typeof ClientCitationIconName[keyof typeof ClientCitationIconName]
56
85
 
57
86
  /**
58
87
  * Represents a Teams client citation to be included in a message.