@microsoft/agents-activity 1.0.0 → 1.0.7-g73d3d58001

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.
@@ -52,9 +52,10 @@ export type ClientCitationIconName =
52
52
  /** PDF document icon */
53
53
  | 'PDF';
54
54
  /**
55
- * @summary Represents a Teams client citation to be included in a message.
56
- * @remarks
57
- * [Learn more about Bot messages with AI-generated content](https://learn.microsoft.com/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=before%2Cbotmessage)
55
+ * Represents a Teams client citation to be included in a message.
56
+ *
57
+ * @remarks
58
+ * [Learn more about Bot messages with AI-generated content](https://learn.microsoft.com/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=before%2Cbotmessage)
58
59
  */
59
60
  export interface ClientCitation {
60
61
  /**
@@ -115,7 +116,8 @@ export interface ClientCitation {
115
116
  };
116
117
  }
117
118
  /**
118
- * @summary Sensitivity usage info for content sent to the user.
119
+ * Sensitivity usage info for content sent to the user.
120
+ *
119
121
  * @remarks
120
122
  * This is used to provide information about the content to the user. See {@link ClientCitation} for more information.
121
123
  */
@@ -190,10 +192,7 @@ export interface AIEntity extends Entity {
190
192
  usageInfo?: SensitivityUsageInfo;
191
193
  }
192
194
  /**
193
- * @summary Adds an AI entity to an activity to indicate that the content was generated by AI.
194
- * @remarks
195
- * This function enhances the activity with metadata that helps clients (like Microsoft Teams)
196
- * understand that the content is AI-generated and optionally includes citations and sensitivity information.
195
+ * Adds an AI entity to an activity to indicate that the content was generated by AI.
197
196
  *
198
197
  * @param activity - The activity to which the AI entity will be added. The activity's entities array will be initialized if it doesn't exist.
199
198
  * @param citations - Optional array of client citations to include with the AI-generated content.
@@ -201,6 +200,10 @@ export interface AIEntity extends Entity {
201
200
  * @param usageInfo - Optional sensitivity usage information that provides context about the content's sensitivity level.
202
201
  * This helps users understand any special handling requirements for the content.
203
202
  *
203
+ * @remarks
204
+ * This function enhances the activity with metadata that helps clients (like Microsoft Teams)
205
+ * understand that the content is AI-generated and optionally includes citations and sensitivity information.
206
+ *
204
207
  * @example
205
208
  * ```typescript
206
209
  * import { Activity } from '../activity';
@@ -6,10 +6,7 @@
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.addAIToActivity = void 0;
8
8
  /**
9
- * @summary Adds an AI entity to an activity to indicate that the content was generated by AI.
10
- * @remarks
11
- * This function enhances the activity with metadata that helps clients (like Microsoft Teams)
12
- * understand that the content is AI-generated and optionally includes citations and sensitivity information.
9
+ * Adds an AI entity to an activity to indicate that the content was generated by AI.
13
10
  *
14
11
  * @param activity - The activity to which the AI entity will be added. The activity's entities array will be initialized if it doesn't exist.
15
12
  * @param citations - Optional array of client citations to include with the AI-generated content.
@@ -17,6 +14,10 @@ exports.addAIToActivity = void 0;
17
14
  * @param usageInfo - Optional sensitivity usage information that provides context about the content's sensitivity level.
18
15
  * This helps users understand any special handling requirements for the content.
19
16
  *
17
+ * @remarks
18
+ * This function enhances the activity with metadata that helps clients (like Microsoft Teams)
19
+ * understand that the content is AI-generated and optionally includes citations and sensitivity information.
20
+ *
20
21
  * @example
21
22
  * ```typescript
22
23
  * import { Activity } from '../activity';
@@ -1 +1 @@
1
- {"version":3,"file":"AIEntity.js","sourceRoot":"","sources":["../../../src/entity/AIEntity.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA0NH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;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;;;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"}
@@ -39,4 +39,4 @@ export { MessageReactionTypes } from './messageReactionTypes';
39
39
  export { TextFormatTypes } from './textFormatTypes';
40
40
  export { TextHighlight } from './textHighlight';
41
41
  export { ActivityTreatments } from './activityTreatments';
42
- export { debug } from './logger';
42
+ export { debug, Logger } from './logger';
package/dist/src/index.js CHANGED
@@ -18,7 +18,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
18
18
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
19
19
  };
20
20
  Object.defineProperty(exports, "__esModule", { value: true });
21
- exports.debug = exports.ActivityTreatments = exports.TextFormatTypes = exports.MessageReactionTypes = exports.InputHints = exports.DeliveryModes = exports.CallerIdConstants = exports.ActivityTypes = exports.ActivityImportance = exports.ActivityEventNames = exports.activityZodSchema = exports.Activity = exports.RoleTypes = exports.EndOfConversationCodes = exports.Channels = exports.AttachmentLayoutTypes = exports.SemanticActionStateTypes = exports.ActionTypes = void 0;
21
+ exports.Logger = exports.debug = exports.ActivityTreatments = exports.TextFormatTypes = exports.MessageReactionTypes = exports.InputHints = exports.DeliveryModes = exports.CallerIdConstants = exports.ActivityTypes = exports.ActivityImportance = exports.ActivityEventNames = exports.activityZodSchema = exports.Activity = exports.RoleTypes = exports.EndOfConversationCodes = exports.Channels = exports.AttachmentLayoutTypes = exports.SemanticActionStateTypes = exports.ActionTypes = void 0;
22
22
  /**
23
23
  * Export statements for various modules.
24
24
  */
@@ -59,4 +59,5 @@ var activityTreatments_1 = require("./activityTreatments");
59
59
  Object.defineProperty(exports, "ActivityTreatments", { enumerable: true, get: function () { return activityTreatments_1.ActivityTreatments; } });
60
60
  var logger_1 = require("./logger");
61
61
  Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return logger_1.debug; } });
62
+ Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_1.Logger; } });
62
63
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AAEH;;GAEG;AACH,oDAAkD;AAAzC,0GAAA,WAAW,OAAA;AAGpB,8EAA4E;AAAnE,oIAAA,wBAAwB,OAAA;AAIjC,4EAA0E;AAAjE,8HAAA,qBAAqB,OAAA;AAG9B,oDAAkD;AAAzC,oGAAA,QAAQ,OAAA;AAGjB,gFAA8E;AAArE,gIAAA,sBAAsB,OAAA;AAE/B,sDAAoD;AAA3C,sGAAA,SAAS,OAAA;AAOlB,oDAAiC;AAEjC,oEAAiD;AAEjD,uCAAwD;AAA/C,oGAAA,QAAQ,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AACpC,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,iDAA+C;AAAtC,8GAAA,aAAa,OAAA;AACtB,yDAAuD;AAA9C,sHAAA,iBAAiB,OAAA;AAC1B,iDAA+C;AAAtC,8GAAA,aAAa,OAAA;AAEtB,2CAAyC;AAAhC,wGAAA,UAAU,OAAA;AAEnB,+DAA6D;AAApD,4HAAA,oBAAoB,OAAA;AAC7B,qDAAmD;AAA1C,kHAAA,eAAe,OAAA;AAExB,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,mCAAgC;AAAvB,+FAAA,KAAK,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AAEH;;GAEG;AACH,oDAAkD;AAAzC,0GAAA,WAAW,OAAA;AAGpB,8EAA4E;AAAnE,oIAAA,wBAAwB,OAAA;AAIjC,4EAA0E;AAAjE,8HAAA,qBAAqB,OAAA;AAG9B,oDAAkD;AAAzC,oGAAA,QAAQ,OAAA;AAGjB,gFAA8E;AAArE,gIAAA,sBAAsB,OAAA;AAE/B,sDAAoD;AAA3C,sGAAA,SAAS,OAAA;AAOlB,oDAAiC;AAEjC,oEAAiD;AAEjD,uCAAwD;AAA/C,oGAAA,QAAQ,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AACpC,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,iDAA+C;AAAtC,8GAAA,aAAa,OAAA;AACtB,yDAAuD;AAA9C,sHAAA,iBAAiB,OAAA;AAC1B,iDAA+C;AAAtC,8GAAA,aAAa,OAAA;AAEtB,2CAAyC;AAAhC,wGAAA,UAAU,OAAA;AAEnB,+DAA6D;AAApD,4HAAA,oBAAoB,OAAA;AAC7B,qDAAmD;AAA1C,kHAAA,eAAe,OAAA;AAExB,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,mCAAwC;AAA/B,+FAAA,KAAK,OAAA;AAAE,gGAAA,MAAM,OAAA"}
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.0.0",
4
+ "version": "1.0.7-g73d3d58001",
5
5
  "homepage": "https://github.com/microsoft/Agents-for-js",
6
6
  "repository": {
7
7
  "type": "git",
@@ -55,9 +55,10 @@ export type ClientCitationIconName =
55
55
  | 'PDF'
56
56
 
57
57
  /**
58
- * @summary Represents a Teams client citation to be included in a message.
59
- * @remarks
60
- * [Learn more about Bot messages with AI-generated content](https://learn.microsoft.com/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=before%2Cbotmessage)
58
+ * Represents a Teams client citation to be included in a message.
59
+ *
60
+ * @remarks
61
+ * [Learn more about Bot messages with AI-generated content](https://learn.microsoft.com/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=before%2Cbotmessage)
61
62
  */
62
63
  export interface ClientCitation {
63
64
  /**
@@ -129,7 +130,8 @@ export interface ClientCitation {
129
130
  }
130
131
 
131
132
  /**
132
- * @summary Sensitivity usage info for content sent to the user.
133
+ * Sensitivity usage info for content sent to the user.
134
+ *
133
135
  * @remarks
134
136
  * This is used to provide information about the content to the user. See {@link ClientCitation} for more information.
135
137
  */
@@ -220,10 +222,7 @@ export interface AIEntity extends Entity {
220
222
  }
221
223
 
222
224
  /**
223
- * @summary Adds an AI entity to an activity to indicate that the content was generated by AI.
224
- * @remarks
225
- * This function enhances the activity with metadata that helps clients (like Microsoft Teams)
226
- * understand that the content is AI-generated and optionally includes citations and sensitivity information.
225
+ * Adds an AI entity to an activity to indicate that the content was generated by AI.
227
226
  *
228
227
  * @param activity - The activity to which the AI entity will be added. The activity's entities array will be initialized if it doesn't exist.
229
228
  * @param citations - Optional array of client citations to include with the AI-generated content.
@@ -231,6 +230,10 @@ export interface AIEntity extends Entity {
231
230
  * @param usageInfo - Optional sensitivity usage information that provides context about the content's sensitivity level.
232
231
  * This helps users understand any special handling requirements for the content.
233
232
  *
233
+ * @remarks
234
+ * This function enhances the activity with metadata that helps clients (like Microsoft Teams)
235
+ * understand that the content is AI-generated and optionally includes citations and sensitivity information.
236
+ *
234
237
  * @example
235
238
  * ```typescript
236
239
  * import { Activity } from '../activity';
package/src/index.ts CHANGED
@@ -45,4 +45,4 @@ export { MessageReactionTypes } from './messageReactionTypes'
45
45
  export { TextFormatTypes } from './textFormatTypes'
46
46
  export { TextHighlight } from './textHighlight'
47
47
  export { ActivityTreatments } from './activityTreatments'
48
- export { debug } from './logger'
48
+ export { debug, Logger } from './logger'