@microsoft/teams.api 0.2.7

package/dist/activities/message/message.d.ts

@@ -0,0 +1,46 @@
+import '../../models/account.js';
+import '../../models/entity/mention-entity.js';
+import '../../models/input-hint.js';
+import '../../models/text-format.js';
+import '../../models/attachment/attachment.js';
+import '../../models/attachment/card-attachment.js';
+import '../../models/attachment/attachment-layout.js';
+import '../../models/suggested-actions.js';
+import '../../models/importance.js';
+import '../../models/delivery-mode.js';
+import '../activity.js';
+export { A as AddMentionOptions, I as IMessageActivity, M as MessageActivity } from '../../message-BKfEV_tV.js';
+import '../../models/role.js';
+import '@microsoft/teams.cards';
+import '../../models/card/animation-card.js';
+import '../../models/card/card-action.js';
+import '../../models/card/media-url.js';
+import '../../models/card/thumbnail-url.js';
+import '../../models/card/audio-card.js';
+import '../../models/card/hero-card.js';
+import '../../models/card/card-image.js';
+import '../../models/card/thumbnail-card.js';
+import '../../models/card/video-card.js';
+import '../../models/oauth/oauth-card.js';
+import '../../models/token/token-post-resource.js';
+import '../../models/token-exchange/token-exchange-resource.js';
+import '../../models/sign-in/sign-in-card.js';
+import '../../models/channel-id.js';
+import '../../models/conversation/conversation-reference.js';
+import '../../models/entity/index.js';
+import '../../models/entity/ai-message-entity.js';
+import '../../models/entity/citation-entity.js';
+import '../../models/entity/sensitive-usage-entity.js';
+import '../../models/entity/client-info-entity.js';
+import '../../models/entity/message-entity.js';
+import '../../models/entity/stream-info-entity.js';
+import '../../models/channel-data/index.js';
+import '../../models/meeting/meeting-info.js';
+import '../../models/meeting/meeting-details.js';
+import '../../models/channel-data/channel-info.js';
+import '../../models/channel-data/notification-info.js';
+import '../../models/channel-data/settings.js';
+import '../../models/channel-data/team-info.js';
+import '../../models/channel-data/tenant-info.js';
+import '../typing.js';
+import './message-update.js';

package/dist/activities/message/message.js

@@ -0,0 +1,250 @@
+'use strict';
+
+var models = require('../../models');
+var activity = require('../activity');
+var utils = require('../utils');
+
+class MessageActivity extends activity.Activity {
+  /**
+   * The text content of the message.
+   */
+  text;
+  /**
+   * The text to speak.
+   */
+  speak;
+  /**
+   * Indicates whether your bot is accepting,
+   * expecting, or ignoring user input after the message is delivered to the client. Possible
+   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
+   */
+  inputHint;
+  /**
+   * The text to display if the channel cannot render cards.
+   */
+  summary;
+  /**
+   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'
+   */
+  textFormat;
+  /**
+   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',
+   * 'carousel'
+   */
+  attachmentLayout;
+  /**
+   * Attachments
+   */
+  attachments;
+  /**
+   * The suggested actions for the activity.
+   */
+  suggestedActions;
+  /**
+   * The importance of the activity. Possible values include: 'low', 'normal', 'high'
+   */
+  importance;
+  /**
+   * A delivery hint to signal to the recipient alternate delivery paths for the activity.
+   * The default delivery mode is "default". Possible values include: 'normal', 'notification'
+   */
+  deliveryMode;
+  /**
+   * The time at which the activity should be considered to be "expired" and should not be
+   * presented to the recipient.
+   */
+  expiration;
+  /**
+   * A value that is associated with the activity.
+   */
+  value;
+  constructor(text = "", value = {}) {
+    super({
+      ...value,
+      type: "message"
+    });
+    Object.assign(this, { text, ...value });
+  }
+  /**
+   * initialize from interface
+   */
+  static from(activity) {
+    return new MessageActivity(activity.text, activity);
+  }
+  /**
+   * convert to interface
+   */
+  toInterface() {
+    return Object.assign(
+      {
+        stripMentionsText: this.stripMentionsText.bind(this),
+        isRecipientMentioned: this.isRecipientMentioned.bind(this),
+        getAccountMention: this.getAccountMention.bind(this)
+      },
+      this
+    );
+  }
+  /**
+   * copy to a new instance
+   */
+  clone(options = {}) {
+    return new MessageActivity(this.text, {
+      ...this.toInterface(),
+      ...options
+    });
+  }
+  /**
+   * The text content of the message.
+   */
+  withText(value) {
+    this.text = value;
+    return this;
+  }
+  /**
+   * The text to speak.
+   */
+  withSpeak(value) {
+    this.speak = value;
+    return this;
+  }
+  /**
+   * Indicates whether your bot is accepting,
+   * expecting, or ignoring user input after the message is delivered to the client. Possible
+   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
+   */
+  withInputHint(value) {
+    this.inputHint = value;
+    return this;
+  }
+  /**
+   * The text to display if the channel cannot render cards.
+   */
+  withSummary(value) {
+    this.summary = value;
+    return this;
+  }
+  /**
+   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'
+   */
+  withTextFormat(value) {
+    this.textFormat = value;
+    return this;
+  }
+  /**
+   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',
+   * 'carousel'
+   */
+  withAttachmentLayout(value) {
+    this.attachmentLayout = value;
+    return this;
+  }
+  /**
+   * The suggested actions for the activity.
+   */
+  withSuggestedActions(value) {
+    this.suggestedActions = value;
+    return this;
+  }
+  /**
+   * The importance of the activity. Possible values include: 'low', 'normal', 'high'
+   */
+  withImportance(value) {
+    this.importance = value;
+    return this;
+  }
+  /**
+   * A delivery hint to signal to the recipient alternate delivery paths for the activity.
+   * The default delivery mode is "default". Possible values include: 'normal', 'notification'
+   */
+  withDeliveryMode(value) {
+    this.deliveryMode = value;
+    return this;
+  }
+  /**
+   * The time at which the activity should be considered to be "expired" and should not be
+   * presented to the recipient.
+   */
+  withExpiration(value) {
+    this.expiration = value;
+    return this;
+  }
+  /**
+   * Append text
+   */
+  addText(text) {
+    this.text += text;
+    return this;
+  }
+  /**
+   * Attachments
+   */
+  addAttachments(...value) {
+    if (!this.attachments) {
+      this.attachments = [];
+    }
+    this.attachments.push(...value);
+    return this;
+  }
+  /**
+   * `@mention` an account
+   * @param account the account to mention
+   * @param options options to customize the mention
+   */
+  addMention(account, options = {}) {
+    const text = options.text || account.name;
+    options.addText || true;
+    {
+      this.addText(`<at>${text}</at>`);
+    }
+    return this.addEntity({
+      type: "mention",
+      mentioned: account,
+      text: `<at>${text}</at>`
+    });
+  }
+  /**
+   * Add a card attachment
+   */
+  addCard(type, content) {
+    return this.addAttachments(models.cardAttachment(type, content));
+  }
+  /**
+   * remove "\<at>...\</at>" text from an activity
+   */
+  stripMentionsText(options = {}) {
+    this.text = utils.stripMentionsText(this, options);
+    return this;
+  }
+  /**
+   * is the recipient account mentioned
+   */
+  isRecipientMentioned() {
+    return (this.entities || []).filter((e) => e.type === "mention").some((e) => e.mentioned.id === this.recipient.id);
+  }
+  /**
+   * get a mention by the account id if exists
+   */
+  getAccountMention(accountId) {
+    return (this.entities || []).filter((e) => e.type === "mention").find((e) => e.mentioned.id === accountId);
+  }
+  /**
+   * Add stream info, making
+   * this a final stream message
+   */
+  addStreamFinal() {
+    if (!this.channelData) {
+      this.channelData = {};
+    }
+    this.channelData.streamId = this.id;
+    this.channelData.streamType = "final";
+    return this.addEntity({
+      type: "streaminfo",
+      streamId: this.id,
+      streamType: "final"
+    });
+  }
+}
+
+exports.MessageActivity = MessageActivity;
+//# sourceMappingURL=message.js.map
+//# sourceMappingURL=message.js.map

package/dist/activities/message/message.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/activities/message/message.ts"],"names":["Activity","cardAttachment","stripMentionsText"],"mappings":";;;;;;AAoGO,MAAM,wBAAwBA,iBAAgD,CAAA;AAAA;AAAA;AAAA;AAAA,EAInF,IAAA;AAAA;AAAA;AAAA;AAAA,EAKA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,OAAA;AAAA;AAAA;AAAA;AAAA,EAKA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAA;AAAA;AAAA;AAAA;AAAA,EAKA,WAAA;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAA;AAAA;AAAA;AAAA;AAAA,EAKA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAA;AAAA;AAAA;AAAA;AAAA,EAKA,KAAA;AAAA,EAEA,WAAY,CAAA,IAAA,GAAe,EAAI,EAAA,KAAA,GAAiD,EAAI,EAAA;AAClF,IAAM,KAAA,CAAA;AAAA,MACJ,GAAG,KAAA;AAAA,MACH,IAAM,EAAA;AAAA,KACP,CAAA;AAED,IAAA,MAAA,CAAO,OAAO,IAAM,EAAA,EAAE,IAAM,EAAA,GAAG,OAAO,CAAA;AAAA;AACxC;AAAA;AAAA;AAAA,EAKA,OAAO,KAAK,QAA4B,EAAA;AACtC,IAAA,OAAO,IAAI,eAAA,CAAgB,QAAS,CAAA,IAAA,EAAM,QAAQ,CAAA;AAAA;AACpD;AAAA;AAAA;AAAA,EAKA,WAAgC,GAAA;AAC9B,IAAA,OAAO,MAAO,CAAA,MAAA;AAAA,MACZ;AAAA,QACE,iBAAmB,EAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,QACnD,oBAAsB,EAAA,IAAA,CAAK,oBAAqB,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,QACzD,iBAAmB,EAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,IAAI;AAAA,OACrD;AAAA,MACA;AAAA,KACF;AAAA;AACF;AAAA;AAAA;AAAA,EAKA,KAAA,CAAM,OAAmD,GAAA,EAAI,EAAA;AAC3D,IAAO,OAAA,IAAI,eAAgB,CAAA,IAAA,CAAK,IAAM,EAAA;AAAA,MACpC,GAAG,KAAK,WAAY,EAAA;AAAA,MACpB,GAAG;AAAA,KACJ,CAAA;AAAA;AACH;AAAA;AAAA;AAAA,EAKA,SAAS,KAAe,EAAA;AACtB,IAAA,IAAA,CAAK,IAAO,GAAA,KAAA;AACZ,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,UAAU,KAAe,EAAA;AACvB,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA;AACb,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,cAAc,KAAkB,EAAA;AAC9B,IAAA,IAAA,CAAK,SAAY,GAAA,KAAA;AACjB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,YAAY,KAAe,EAAA;AACzB,IAAA,IAAA,CAAK,OAAU,GAAA,KAAA;AACf,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,eAAe,KAAmB,EAAA;AAChC,IAAA,IAAA,CAAK,UAAa,GAAA,KAAA;AAClB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,qBAAqB,KAAyB,EAAA;AAC5C,IAAA,IAAA,CAAK,gBAAmB,GAAA,KAAA;AACxB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,qBAAqB,KAAyB,EAAA;AAC5C,IAAA,IAAA,CAAK,gBAAmB,GAAA,KAAA;AACxB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,eAAe,KAAmB,EAAA;AAChC,IAAA,IAAA,CAAK,UAAa,GAAA,KAAA;AAClB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAiB,KAAqB,EAAA;AACpC,IAAA,IAAA,CAAK,YAAe,GAAA,KAAA;AACpB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,eAAe,KAAa,EAAA;AAC1B,IAAA,IAAA,CAAK,UAAa,GAAA,KAAA;AAClB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,QAAQ,IAAc,EAAA;AACpB,IAAA,IAAA,CAAK,IAAQ,IAAA,IAAA;AACb,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,kBAAkB,KAAqB,EAAA;AACrC,IAAI,IAAA,CAAC,KAAK,WAAa,EAAA;AACrB,MAAA,IAAA,CAAK,cAAc,EAAC;AAAA;AAGtB,IAAK,IAAA,CAAA,WAAA,CAAY,IAAK,CAAA,GAAG,KAAK,CAAA;AAC9B,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,UAAW,CAAA,OAAA,EAAkB,OAA6B,GAAA,EAAI,EAAA;AAC5D,IAAM,MAAA,IAAA,GAAO,OAAQ,CAAA,IAAA,IAAQ,OAAQ,CAAA,IAAA;AACrC,IAAgB,QAAQ,OAAW,IAAA;AAEnC,IAAa;AACX,MAAK,IAAA,CAAA,OAAA,CAAQ,CAAO,IAAA,EAAA,IAAI,CAAO,KAAA,CAAA,CAAA;AAAA;AAGjC,IAAA,OAAO,KAAK,SAAU,CAAA;AAAA,MACpB,IAAM,EAAA,SAAA;AAAA,MACN,SAAW,EAAA,OAAA;AAAA,MACX,IAAA,EAAM,OAAO,IAAI,CAAA,KAAA;AAAA,KAClB,CAAA;AAAA;AACH;AAAA;AAAA;AAAA,EAKA,OAAA,CAAsC,MAAS,OAA4C,EAAA;AACzF,IAAA,OAAO,IAAK,CAAA,cAAA,CAAeC,qBAAe,CAAA,IAAA,EAAM,OAAO,CAAC,CAAA;AAAA;AAC1D;AAAA;AAAA;AAAA,EAKA,iBAAA,CAAkB,OAAoC,GAAA,EAAI,EAAA;AACxD,IAAK,IAAA,CAAA,IAAA,GAAOC,uBAAkB,CAAA,IAAA,EAAM,OAAO,CAAA;AAC3C,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,oBAAuB,GAAA;AACrB,IAAA,OAAA,CAAQ,KAAK,QAAY,IAAA,IACtB,MAAO,CAAA,CAAC,MAAM,CAAE,CAAA,IAAA,KAAS,SAAS,CAClC,CAAA,IAAA,CAAK,CAAC,CAAM,KAAA,CAAA,CAAE,UAAU,EAAO,KAAA,IAAA,CAAK,UAAU,EAAE,CAAA;AAAA;AACrD;AAAA;AAAA;AAAA,EAKA,kBAAkB,SAAmB,EAAA;AACnC,IAAA,OAAA,CAAQ,KAAK,QAAY,IAAA,EACtB,EAAA,MAAA,CAAO,CAAC,CAAM,KAAA,CAAA,CAAE,IAAS,KAAA,SAAS,EAClC,IAAK,CAAA,CAAC,MAAM,CAAE,CAAA,SAAA,CAAU,OAAO,SAAS,CAAA;AAAA;AAC7C;AAAA;AAAA;AAAA;AAAA,EAMA,cAAiB,GAAA;AACf,IAAI,IAAA,CAAC,KAAK,WAAa,EAAA;AACrB,MAAA,IAAA,CAAK,cAAc,EAAC;AAAA;AAGtB,IAAK,IAAA,CAAA,WAAA,CAAY,WAAW,IAAK,CAAA,EAAA;AACjC,IAAA,IAAA,CAAK,YAAY,UAAa,GAAA,OAAA;AAE9B,IAAA,OAAO,KAAK,SAAU,CAAA;AAAA,MACpB,IAAM,EAAA,YAAA;AAAA,MACN,UAAU,IAAK,CAAA,EAAA;AAAA,MACf,UAAY,EAAA;AAAA,KACb,CAAA;AAAA;AAEL","file":"message.js","sourcesContent":["import {\n  Account,\n  Attachment,\n  AttachmentLayout,\n  cardAttachment,\n  CardAttachmentType,\n  CardAttachmentTypes,\n  DeliveryMode,\n  Importance,\n  InputHint,\n  MentionEntity,\n  SuggestedActions,\n  TextFormat,\n} from '../../models';\n\nimport { IActivity, Activity } from '../activity';\nimport { stripMentionsText, StripMentionsTextOptions } from '../utils';\n\nexport interface IMessageActivity extends IActivity<'message'> {\n  /**\n   * The text content of the message.\n   */\n  text: string;\n\n  /**\n   * The text to speak.\n   */\n  speak?: string;\n\n  /**\n   * Indicates whether your bot is accepting,\n   * expecting, or ignoring user input after the message is delivered to the client. Possible\n   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'\n   */\n  inputHint?: InputHint;\n\n  /**\n   * The text to display if the channel cannot render cards.\n   */\n  summary?: string;\n\n  /**\n   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'\n   */\n  textFormat?: TextFormat;\n\n  /**\n   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',\n   * 'carousel'\n   */\n  attachmentLayout?: AttachmentLayout;\n\n  /**\n   * Attachments\n   */\n  attachments?: Attachment[];\n\n  /**\n   * The suggested actions for the activity.\n   */\n  suggestedActions?: SuggestedActions;\n\n  /**\n   * The importance of the activity. Possible values include: 'low', 'normal', 'high'\n   */\n  importance?: Importance;\n\n  /**\n   * A delivery hint to signal to the recipient alternate delivery paths for the activity.\n   * The default delivery mode is \"default\". Possible values include: 'normal', 'notification'\n   */\n  deliveryMode?: DeliveryMode;\n\n  /**\n   * The time at which the activity should be considered to be \"expired\" and should not be\n   * presented to the recipient.\n   */\n  expiration?: Date;\n\n  /**\n   * A value that is associated with the activity.\n   */\n  value?: any;\n\n  /**\n   * remove \"\\<at>...\\</at>\" text from an activity\n   */\n  stripMentionsText(options?: StripMentionsTextOptions): IMessageActivity;\n\n  /**\n   * is the recipient account mentioned\n   */\n  isRecipientMentioned(): boolean;\n\n  /**\n   * get a mention by the account id if exists\n   */\n  getAccountMention(accountId: string): MentionEntity | undefined;\n}\n\nexport class MessageActivity extends Activity<'message'> implements IMessageActivity {\n  /**\n   * The text content of the message.\n   */\n  text!: string;\n\n  /**\n   * The text to speak.\n   */\n  speak?: string;\n\n  /**\n   * Indicates whether your bot is accepting,\n   * expecting, or ignoring user input after the message is delivered to the client. Possible\n   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'\n   */\n  inputHint?: InputHint;\n\n  /**\n   * The text to display if the channel cannot render cards.\n   */\n  summary?: string;\n\n  /**\n   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'\n   */\n  textFormat?: TextFormat;\n\n  /**\n   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',\n   * 'carousel'\n   */\n  attachmentLayout?: AttachmentLayout;\n\n  /**\n   * Attachments\n   */\n  attachments?: Attachment[];\n\n  /**\n   * The suggested actions for the activity.\n   */\n  suggestedActions?: SuggestedActions;\n\n  /**\n   * The importance of the activity. Possible values include: 'low', 'normal', 'high'\n   */\n  importance?: Importance;\n\n  /**\n   * A delivery hint to signal to the recipient alternate delivery paths for the activity.\n   * The default delivery mode is \"default\". Possible values include: 'normal', 'notification'\n   */\n  deliveryMode?: DeliveryMode;\n\n  /**\n   * The time at which the activity should be considered to be \"expired\" and should not be\n   * presented to the recipient.\n   */\n  expiration?: Date;\n\n  /**\n   * A value that is associated with the activity.\n   */\n  value?: any;\n\n  constructor(text: string = '', value: Omit<Partial<IMessageActivity>, 'type'> = {}) {\n    super({\n      ...value,\n      type: 'message',\n    });\n\n    Object.assign(this, { text, ...value });\n  }\n\n  /**\n   * initialize from interface\n   */\n  static from(activity: IMessageActivity) {\n    return new MessageActivity(activity.text, activity);\n  }\n\n  /**\n   * convert to interface\n   */\n  toInterface(): IMessageActivity {\n    return Object.assign(\n      {\n        stripMentionsText: this.stripMentionsText.bind(this),\n        isRecipientMentioned: this.isRecipientMentioned.bind(this),\n        getAccountMention: this.getAccountMention.bind(this),\n      },\n      this\n    );\n  }\n\n  /**\n   * copy to a new instance\n   */\n  clone(options: Omit<Partial<IMessageActivity>, 'type'> = {}) {\n    return new MessageActivity(this.text, {\n      ...this.toInterface(),\n      ...options,\n    });\n  }\n\n  /**\n   * The text content of the message.\n   */\n  withText(value: string) {\n    this.text = value;\n    return this;\n  }\n\n  /**\n   * The text to speak.\n   */\n  withSpeak(value: string) {\n    this.speak = value;\n    return this;\n  }\n\n  /**\n   * Indicates whether your bot is accepting,\n   * expecting, or ignoring user input after the message is delivered to the client. Possible\n   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'\n   */\n  withInputHint(value: InputHint) {\n    this.inputHint = value;\n    return this;\n  }\n\n  /**\n   * The text to display if the channel cannot render cards.\n   */\n  withSummary(value: string) {\n    this.summary = value;\n    return this;\n  }\n\n  /**\n   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'\n   */\n  withTextFormat(value: TextFormat) {\n    this.textFormat = value;\n    return this;\n  }\n\n  /**\n   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',\n   * 'carousel'\n   */\n  withAttachmentLayout(value: AttachmentLayout) {\n    this.attachmentLayout = value;\n    return this;\n  }\n\n  /**\n   * The suggested actions for the activity.\n   */\n  withSuggestedActions(value: SuggestedActions) {\n    this.suggestedActions = value;\n    return this;\n  }\n\n  /**\n   * The importance of the activity. Possible values include: 'low', 'normal', 'high'\n   */\n  withImportance(value: Importance) {\n    this.importance = value;\n    return this;\n  }\n\n  /**\n   * A delivery hint to signal to the recipient alternate delivery paths for the activity.\n   * The default delivery mode is \"default\". Possible values include: 'normal', 'notification'\n   */\n  withDeliveryMode(value: DeliveryMode) {\n    this.deliveryMode = value;\n    return this;\n  }\n\n  /**\n   * The time at which the activity should be considered to be \"expired\" and should not be\n   * presented to the recipient.\n   */\n  withExpiration(value: Date) {\n    this.expiration = value;\n    return this;\n  }\n\n  /**\n   * Append text\n   */\n  addText(text: string) {\n    this.text += text;\n    return this;\n  }\n\n  /**\n   * Attachments\n   */\n  addAttachments(...value: Attachment[]) {\n    if (!this.attachments) {\n      this.attachments = [];\n    }\n\n    this.attachments.push(...value);\n    return this;\n  }\n\n  /**\n   * `@mention` an account\n   * @param account the account to mention\n   * @param options options to customize the mention\n   */\n  addMention(account: Account, options: AddMentionOptions = {}) {\n    const text = options.text || account.name;\n    const addText = options.addText || true;\n\n    if (addText) {\n      this.addText(`<at>${text}</at>`);\n    }\n\n    return this.addEntity({\n      type: 'mention',\n      mentioned: account,\n      text: `<at>${text}</at>`,\n    });\n  }\n\n  /**\n   * Add a card attachment\n   */\n  addCard<T extends CardAttachmentType>(type: T, content: CardAttachmentTypes[T]['content']) {\n    return this.addAttachments(cardAttachment(type, content));\n  }\n\n  /**\n   * remove \"\\<at>...\\</at>\" text from an activity\n   */\n  stripMentionsText(options: StripMentionsTextOptions = {}) {\n    this.text = stripMentionsText(this, options);\n    return this;\n  }\n\n  /**\n   * is the recipient account mentioned\n   */\n  isRecipientMentioned() {\n    return (this.entities || [])\n      .filter((e) => e.type === 'mention')\n      .some((e) => e.mentioned.id === this.recipient.id);\n  }\n\n  /**\n   * get a mention by the account id if exists\n   */\n  getAccountMention(accountId: string) {\n    return (this.entities || [])\n      .filter((e) => e.type === 'mention')\n      .find((e) => e.mentioned.id === accountId);\n  }\n\n  /**\n   * Add stream info, making\n   * this a final stream message\n   */\n  addStreamFinal() {\n    if (!this.channelData) {\n      this.channelData = {};\n    }\n\n    this.channelData.streamId = this.id;\n    this.channelData.streamType = 'final';\n\n    return this.addEntity({\n      type: 'streaminfo',\n      streamId: this.id,\n      streamType: 'final',\n    });\n  }\n}\n\n/**\n * options for adding a mention\n * to an activity\n */\nexport type AddMentionOptions = {\n  /**\n   * if `true`, append the mention `text` to the `activity.text`\n   * @default true\n   */\n  readonly addText?: boolean;\n\n  /**\n   * the `text` to use for the mention\n   *\n   * @default `account.name`\n   * @remark\n   * this text should not include `<at>` or `</at>`\n   */\n  readonly text?: string;\n};\n"]}

package/dist/activities/message/message.mjs

@@ -0,0 +1,248 @@
+import { cardAttachment } from '../../models';
+import { Activity } from '../activity';
+import { stripMentionsText } from '../utils';
+
+class MessageActivity extends Activity {
+  /**
+   * The text content of the message.
+   */
+  text;
+  /**
+   * The text to speak.
+   */
+  speak;
+  /**
+   * Indicates whether your bot is accepting,
+   * expecting, or ignoring user input after the message is delivered to the client. Possible
+   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
+   */
+  inputHint;
+  /**
+   * The text to display if the channel cannot render cards.
+   */
+  summary;
+  /**
+   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'
+   */
+  textFormat;
+  /**
+   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',
+   * 'carousel'
+   */
+  attachmentLayout;
+  /**
+   * Attachments
+   */
+  attachments;
+  /**
+   * The suggested actions for the activity.
+   */
+  suggestedActions;
+  /**
+   * The importance of the activity. Possible values include: 'low', 'normal', 'high'
+   */
+  importance;
+  /**
+   * A delivery hint to signal to the recipient alternate delivery paths for the activity.
+   * The default delivery mode is "default". Possible values include: 'normal', 'notification'
+   */
+  deliveryMode;
+  /**
+   * The time at which the activity should be considered to be "expired" and should not be
+   * presented to the recipient.
+   */
+  expiration;
+  /**
+   * A value that is associated with the activity.
+   */
+  value;
+  constructor(text = "", value = {}) {
+    super({
+      ...value,
+      type: "message"
+    });
+    Object.assign(this, { text, ...value });
+  }
+  /**
+   * initialize from interface
+   */
+  static from(activity) {
+    return new MessageActivity(activity.text, activity);
+  }
+  /**
+   * convert to interface
+   */
+  toInterface() {
+    return Object.assign(
+      {
+        stripMentionsText: this.stripMentionsText.bind(this),
+        isRecipientMentioned: this.isRecipientMentioned.bind(this),
+        getAccountMention: this.getAccountMention.bind(this)
+      },
+      this
+    );
+  }
+  /**
+   * copy to a new instance
+   */
+  clone(options = {}) {
+    return new MessageActivity(this.text, {
+      ...this.toInterface(),
+      ...options
+    });
+  }
+  /**
+   * The text content of the message.
+   */
+  withText(value) {
+    this.text = value;
+    return this;
+  }
+  /**
+   * The text to speak.
+   */
+  withSpeak(value) {
+    this.speak = value;
+    return this;
+  }
+  /**
+   * Indicates whether your bot is accepting,
+   * expecting, or ignoring user input after the message is delivered to the client. Possible
+   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
+   */
+  withInputHint(value) {
+    this.inputHint = value;
+    return this;
+  }
+  /**
+   * The text to display if the channel cannot render cards.
+   */
+  withSummary(value) {
+    this.summary = value;
+    return this;
+  }
+  /**
+   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'
+   */
+  withTextFormat(value) {
+    this.textFormat = value;
+    return this;
+  }
+  /**
+   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',
+   * 'carousel'
+   */
+  withAttachmentLayout(value) {
+    this.attachmentLayout = value;
+    return this;
+  }
+  /**
+   * The suggested actions for the activity.
+   */
+  withSuggestedActions(value) {
+    this.suggestedActions = value;
+    return this;
+  }
+  /**
+   * The importance of the activity. Possible values include: 'low', 'normal', 'high'
+   */
+  withImportance(value) {
+    this.importance = value;
+    return this;
+  }
+  /**
+   * A delivery hint to signal to the recipient alternate delivery paths for the activity.
+   * The default delivery mode is "default". Possible values include: 'normal', 'notification'
+   */
+  withDeliveryMode(value) {
+    this.deliveryMode = value;
+    return this;
+  }
+  /**
+   * The time at which the activity should be considered to be "expired" and should not be
+   * presented to the recipient.
+   */
+  withExpiration(value) {
+    this.expiration = value;
+    return this;
+  }
+  /**
+   * Append text
+   */
+  addText(text) {
+    this.text += text;
+    return this;
+  }
+  /**
+   * Attachments
+   */
+  addAttachments(...value) {
+    if (!this.attachments) {
+      this.attachments = [];
+    }
+    this.attachments.push(...value);
+    return this;
+  }
+  /**
+   * `@mention` an account
+   * @param account the account to mention
+   * @param options options to customize the mention
+   */
+  addMention(account, options = {}) {
+    const text = options.text || account.name;
+    options.addText || true;
+    {
+      this.addText(`<at>${text}</at>`);
+    }
+    return this.addEntity({
+      type: "mention",
+      mentioned: account,
+      text: `<at>${text}</at>`
+    });
+  }
+  /**
+   * Add a card attachment
+   */
+  addCard(type, content) {
+    return this.addAttachments(cardAttachment(type, content));
+  }
+  /**
+   * remove "\<at>...\</at>" text from an activity
+   */
+  stripMentionsText(options = {}) {
+    this.text = stripMentionsText(this, options);
+    return this;
+  }
+  /**
+   * is the recipient account mentioned
+   */
+  isRecipientMentioned() {
+    return (this.entities || []).filter((e) => e.type === "mention").some((e) => e.mentioned.id === this.recipient.id);
+  }
+  /**
+   * get a mention by the account id if exists
+   */
+  getAccountMention(accountId) {
+    return (this.entities || []).filter((e) => e.type === "mention").find((e) => e.mentioned.id === accountId);
+  }
+  /**
+   * Add stream info, making
+   * this a final stream message
+   */
+  addStreamFinal() {
+    if (!this.channelData) {
+      this.channelData = {};
+    }
+    this.channelData.streamId = this.id;
+    this.channelData.streamType = "final";
+    return this.addEntity({
+      type: "streaminfo",
+      streamId: this.id,
+      streamType: "final"
+    });
+  }
+}
+
+export { MessageActivity };
+//# sourceMappingURL=message.mjs.map
+//# sourceMappingURL=message.mjs.map

package/dist/activities/message/message.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/activities/message/message.ts"],"names":[],"mappings":";;;;AAoGO,MAAM,wBAAwB,QAAgD,CAAA;AAAA;AAAA;AAAA;AAAA,EAInF,IAAA;AAAA;AAAA;AAAA;AAAA,EAKA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,OAAA;AAAA;AAAA;AAAA;AAAA,EAKA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAA;AAAA;AAAA;AAAA;AAAA,EAKA,WAAA;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAA;AAAA;AAAA;AAAA;AAAA,EAKA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAA;AAAA;AAAA;AAAA;AAAA,EAKA,KAAA;AAAA,EAEA,WAAY,CAAA,IAAA,GAAe,EAAI,EAAA,KAAA,GAAiD,EAAI,EAAA;AAClF,IAAM,KAAA,CAAA;AAAA,MACJ,GAAG,KAAA;AAAA,MACH,IAAM,EAAA;AAAA,KACP,CAAA;AAED,IAAA,MAAA,CAAO,OAAO,IAAM,EAAA,EAAE,IAAM,EAAA,GAAG,OAAO,CAAA;AAAA;AACxC;AAAA;AAAA;AAAA,EAKA,OAAO,KAAK,QAA4B,EAAA;AACtC,IAAA,OAAO,IAAI,eAAA,CAAgB,QAAS,CAAA,IAAA,EAAM,QAAQ,CAAA;AAAA;AACpD;AAAA;AAAA;AAAA,EAKA,WAAgC,GAAA;AAC9B,IAAA,OAAO,MAAO,CAAA,MAAA;AAAA,MACZ;AAAA,QACE,iBAAmB,EAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,QACnD,oBAAsB,EAAA,IAAA,CAAK,oBAAqB,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,QACzD,iBAAmB,EAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,IAAI;AAAA,OACrD;AAAA,MACA;AAAA,KACF;AAAA;AACF;AAAA;AAAA;AAAA,EAKA,KAAA,CAAM,OAAmD,GAAA,EAAI,EAAA;AAC3D,IAAO,OAAA,IAAI,eAAgB,CAAA,IAAA,CAAK,IAAM,EAAA;AAAA,MACpC,GAAG,KAAK,WAAY,EAAA;AAAA,MACpB,GAAG;AAAA,KACJ,CAAA;AAAA;AACH;AAAA;AAAA;AAAA,EAKA,SAAS,KAAe,EAAA;AACtB,IAAA,IAAA,CAAK,IAAO,GAAA,KAAA;AACZ,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,UAAU,KAAe,EAAA;AACvB,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA;AACb,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,cAAc,KAAkB,EAAA;AAC9B,IAAA,IAAA,CAAK,SAAY,GAAA,KAAA;AACjB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,YAAY,KAAe,EAAA;AACzB,IAAA,IAAA,CAAK,OAAU,GAAA,KAAA;AACf,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,eAAe,KAAmB,EAAA;AAChC,IAAA,IAAA,CAAK,UAAa,GAAA,KAAA;AAClB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,qBAAqB,KAAyB,EAAA;AAC5C,IAAA,IAAA,CAAK,gBAAmB,GAAA,KAAA;AACxB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,qBAAqB,KAAyB,EAAA;AAC5C,IAAA,IAAA,CAAK,gBAAmB,GAAA,KAAA;AACxB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,eAAe,KAAmB,EAAA;AAChC,IAAA,IAAA,CAAK,UAAa,GAAA,KAAA;AAClB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAiB,KAAqB,EAAA;AACpC,IAAA,IAAA,CAAK,YAAe,GAAA,KAAA;AACpB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,eAAe,KAAa,EAAA;AAC1B,IAAA,IAAA,CAAK,UAAa,GAAA,KAAA;AAClB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,QAAQ,IAAc,EAAA;AACpB,IAAA,IAAA,CAAK,IAAQ,IAAA,IAAA;AACb,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,kBAAkB,KAAqB,EAAA;AACrC,IAAI,IAAA,CAAC,KAAK,WAAa,EAAA;AACrB,MAAA,IAAA,CAAK,cAAc,EAAC;AAAA;AAGtB,IAAK,IAAA,CAAA,WAAA,CAAY,IAAK,CAAA,GAAG,KAAK,CAAA;AAC9B,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,UAAW,CAAA,OAAA,EAAkB,OAA6B,GAAA,EAAI,EAAA;AAC5D,IAAM,MAAA,IAAA,GAAO,OAAQ,CAAA,IAAA,IAAQ,OAAQ,CAAA,IAAA;AACrC,IAAgB,QAAQ,OAAW,IAAA;AAEnC,IAAa;AACX,MAAK,IAAA,CAAA,OAAA,CAAQ,CAAO,IAAA,EAAA,IAAI,CAAO,KAAA,CAAA,CAAA;AAAA;AAGjC,IAAA,OAAO,KAAK,SAAU,CAAA;AAAA,MACpB,IAAM,EAAA,SAAA;AAAA,MACN,SAAW,EAAA,OAAA;AAAA,MACX,IAAA,EAAM,OAAO,IAAI,CAAA,KAAA;AAAA,KAClB,CAAA;AAAA;AACH;AAAA;AAAA;AAAA,EAKA,OAAA,CAAsC,MAAS,OAA4C,EAAA;AACzF,IAAA,OAAO,IAAK,CAAA,cAAA,CAAe,cAAe,CAAA,IAAA,EAAM,OAAO,CAAC,CAAA;AAAA;AAC1D;AAAA;AAAA;AAAA,EAKA,iBAAA,CAAkB,OAAoC,GAAA,EAAI,EAAA;AACxD,IAAK,IAAA,CAAA,IAAA,GAAO,iBAAkB,CAAA,IAAA,EAAM,OAAO,CAAA;AAC3C,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,oBAAuB,GAAA;AACrB,IAAA,OAAA,CAAQ,KAAK,QAAY,IAAA,IACtB,MAAO,CAAA,CAAC,MAAM,CAAE,CAAA,IAAA,KAAS,SAAS,CAClC,CAAA,IAAA,CAAK,CAAC,CAAM,KAAA,CAAA,CAAE,UAAU,EAAO,KAAA,IAAA,CAAK,UAAU,EAAE,CAAA;AAAA;AACrD;AAAA;AAAA;AAAA,EAKA,kBAAkB,SAAmB,EAAA;AACnC,IAAA,OAAA,CAAQ,KAAK,QAAY,IAAA,EACtB,EAAA,MAAA,CAAO,CAAC,CAAM,KAAA,CAAA,CAAE,IAAS,KAAA,SAAS,EAClC,IAAK,CAAA,CAAC,MAAM,CAAE,CAAA,SAAA,CAAU,OAAO,SAAS,CAAA;AAAA;AAC7C;AAAA;AAAA;AAAA;AAAA,EAMA,cAAiB,GAAA;AACf,IAAI,IAAA,CAAC,KAAK,WAAa,EAAA;AACrB,MAAA,IAAA,CAAK,cAAc,EAAC;AAAA;AAGtB,IAAK,IAAA,CAAA,WAAA,CAAY,WAAW,IAAK,CAAA,EAAA;AACjC,IAAA,IAAA,CAAK,YAAY,UAAa,GAAA,OAAA;AAE9B,IAAA,OAAO,KAAK,SAAU,CAAA;AAAA,MACpB,IAAM,EAAA,YAAA;AAAA,MACN,UAAU,IAAK,CAAA,EAAA;AAAA,MACf,UAAY,EAAA;AAAA,KACb,CAAA;AAAA;AAEL","file":"message.mjs","sourcesContent":["import {\n  Account,\n  Attachment,\n  AttachmentLayout,\n  cardAttachment,\n  CardAttachmentType,\n  CardAttachmentTypes,\n  DeliveryMode,\n  Importance,\n  InputHint,\n  MentionEntity,\n  SuggestedActions,\n  TextFormat,\n} from '../../models';\n\nimport { IActivity, Activity } from '../activity';\nimport { stripMentionsText, StripMentionsTextOptions } from '../utils';\n\nexport interface IMessageActivity extends IActivity<'message'> {\n  /**\n   * The text content of the message.\n   */\n  text: string;\n\n  /**\n   * The text to speak.\n   */\n  speak?: string;\n\n  /**\n   * Indicates whether your bot is accepting,\n   * expecting, or ignoring user input after the message is delivered to the client. Possible\n   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'\n   */\n  inputHint?: InputHint;\n\n  /**\n   * The text to display if the channel cannot render cards.\n   */\n  summary?: string;\n\n  /**\n   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'\n   */\n  textFormat?: TextFormat;\n\n  /**\n   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',\n   * 'carousel'\n   */\n  attachmentLayout?: AttachmentLayout;\n\n  /**\n   * Attachments\n   */\n  attachments?: Attachment[];\n\n  /**\n   * The suggested actions for the activity.\n   */\n  suggestedActions?: SuggestedActions;\n\n  /**\n   * The importance of the activity. Possible values include: 'low', 'normal', 'high'\n   */\n  importance?: Importance;\n\n  /**\n   * A delivery hint to signal to the recipient alternate delivery paths for the activity.\n   * The default delivery mode is \"default\". Possible values include: 'normal', 'notification'\n   */\n  deliveryMode?: DeliveryMode;\n\n  /**\n   * The time at which the activity should be considered to be \"expired\" and should not be\n   * presented to the recipient.\n   */\n  expiration?: Date;\n\n  /**\n   * A value that is associated with the activity.\n   */\n  value?: any;\n\n  /**\n   * remove \"\\<at>...\\</at>\" text from an activity\n   */\n  stripMentionsText(options?: StripMentionsTextOptions): IMessageActivity;\n\n  /**\n   * is the recipient account mentioned\n   */\n  isRecipientMentioned(): boolean;\n\n  /**\n   * get a mention by the account id if exists\n   */\n  getAccountMention(accountId: string): MentionEntity | undefined;\n}\n\nexport class MessageActivity extends Activity<'message'> implements IMessageActivity {\n  /**\n   * The text content of the message.\n   */\n  text!: string;\n\n  /**\n   * The text to speak.\n   */\n  speak?: string;\n\n  /**\n   * Indicates whether your bot is accepting,\n   * expecting, or ignoring user input after the message is delivered to the client. Possible\n   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'\n   */\n  inputHint?: InputHint;\n\n  /**\n   * The text to display if the channel cannot render cards.\n   */\n  summary?: string;\n\n  /**\n   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'\n   */\n  textFormat?: TextFormat;\n\n  /**\n   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',\n   * 'carousel'\n   */\n  attachmentLayout?: AttachmentLayout;\n\n  /**\n   * Attachments\n   */\n  attachments?: Attachment[];\n\n  /**\n   * The suggested actions for the activity.\n   */\n  suggestedActions?: SuggestedActions;\n\n  /**\n   * The importance of the activity. Possible values include: 'low', 'normal', 'high'\n   */\n  importance?: Importance;\n\n  /**\n   * A delivery hint to signal to the recipient alternate delivery paths for the activity.\n   * The default delivery mode is \"default\". Possible values include: 'normal', 'notification'\n   */\n  deliveryMode?: DeliveryMode;\n\n  /**\n   * The time at which the activity should be considered to be \"expired\" and should not be\n   * presented to the recipient.\n   */\n  expiration?: Date;\n\n  /**\n   * A value that is associated with the activity.\n   */\n  value?: any;\n\n  constructor(text: string = '', value: Omit<Partial<IMessageActivity>, 'type'> = {}) {\n    super({\n      ...value,\n      type: 'message',\n    });\n\n    Object.assign(this, { text, ...value });\n  }\n\n  /**\n   * initialize from interface\n   */\n  static from(activity: IMessageActivity) {\n    return new MessageActivity(activity.text, activity);\n  }\n\n  /**\n   * convert to interface\n   */\n  toInterface(): IMessageActivity {\n    return Object.assign(\n      {\n        stripMentionsText: this.stripMentionsText.bind(this),\n        isRecipientMentioned: this.isRecipientMentioned.bind(this),\n        getAccountMention: this.getAccountMention.bind(this),\n      },\n      this\n    );\n  }\n\n  /**\n   * copy to a new instance\n   */\n  clone(options: Omit<Partial<IMessageActivity>, 'type'> = {}) {\n    return new MessageActivity(this.text, {\n      ...this.toInterface(),\n      ...options,\n    });\n  }\n\n  /**\n   * The text content of the message.\n   */\n  withText(value: string) {\n    this.text = value;\n    return this;\n  }\n\n  /**\n   * The text to speak.\n   */\n  withSpeak(value: string) {\n    this.speak = value;\n    return this;\n  }\n\n  /**\n   * Indicates whether your bot is accepting,\n   * expecting, or ignoring user input after the message is delivered to the client. Possible\n   * values include: 'acceptingInput', 'ignoringInput', 'expectingInput'\n   */\n  withInputHint(value: InputHint) {\n    this.inputHint = value;\n    return this;\n  }\n\n  /**\n   * The text to display if the channel cannot render cards.\n   */\n  withSummary(value: string) {\n    this.summary = value;\n    return this;\n  }\n\n  /**\n   * Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'\n   */\n  withTextFormat(value: TextFormat) {\n    this.textFormat = value;\n    return this;\n  }\n\n  /**\n   * The layout hint for multiple attachments. Default: list. Possible values include: 'list',\n   * 'carousel'\n   */\n  withAttachmentLayout(value: AttachmentLayout) {\n    this.attachmentLayout = value;\n    return this;\n  }\n\n  /**\n   * The suggested actions for the activity.\n   */\n  withSuggestedActions(value: SuggestedActions) {\n    this.suggestedActions = value;\n    return this;\n  }\n\n  /**\n   * The importance of the activity. Possible values include: 'low', 'normal', 'high'\n   */\n  withImportance(value: Importance) {\n    this.importance = value;\n    return this;\n  }\n\n  /**\n   * A delivery hint to signal to the recipient alternate delivery paths for the activity.\n   * The default delivery mode is \"default\". Possible values include: 'normal', 'notification'\n   */\n  withDeliveryMode(value: DeliveryMode) {\n    this.deliveryMode = value;\n    return this;\n  }\n\n  /**\n   * The time at which the activity should be considered to be \"expired\" and should not be\n   * presented to the recipient.\n   */\n  withExpiration(value: Date) {\n    this.expiration = value;\n    return this;\n  }\n\n  /**\n   * Append text\n   */\n  addText(text: string) {\n    this.text += text;\n    return this;\n  }\n\n  /**\n   * Attachments\n   */\n  addAttachments(...value: Attachment[]) {\n    if (!this.attachments) {\n      this.attachments = [];\n    }\n\n    this.attachments.push(...value);\n    return this;\n  }\n\n  /**\n   * `@mention` an account\n   * @param account the account to mention\n   * @param options options to customize the mention\n   */\n  addMention(account: Account, options: AddMentionOptions = {}) {\n    const text = options.text || account.name;\n    const addText = options.addText || true;\n\n    if (addText) {\n      this.addText(`<at>${text}</at>`);\n    }\n\n    return this.addEntity({\n      type: 'mention',\n      mentioned: account,\n      text: `<at>${text}</at>`,\n    });\n  }\n\n  /**\n   * Add a card attachment\n   */\n  addCard<T extends CardAttachmentType>(type: T, content: CardAttachmentTypes[T]['content']) {\n    return this.addAttachments(cardAttachment(type, content));\n  }\n\n  /**\n   * remove \"\\<at>...\\</at>\" text from an activity\n   */\n  stripMentionsText(options: StripMentionsTextOptions = {}) {\n    this.text = stripMentionsText(this, options);\n    return this;\n  }\n\n  /**\n   * is the recipient account mentioned\n   */\n  isRecipientMentioned() {\n    return (this.entities || [])\n      .filter((e) => e.type === 'mention')\n      .some((e) => e.mentioned.id === this.recipient.id);\n  }\n\n  /**\n   * get a mention by the account id if exists\n   */\n  getAccountMention(accountId: string) {\n    return (this.entities || [])\n      .filter((e) => e.type === 'mention')\n      .find((e) => e.mentioned.id === accountId);\n  }\n\n  /**\n   * Add stream info, making\n   * this a final stream message\n   */\n  addStreamFinal() {\n    if (!this.channelData) {\n      this.channelData = {};\n    }\n\n    this.channelData.streamId = this.id;\n    this.channelData.streamType = 'final';\n\n    return this.addEntity({\n      type: 'streaminfo',\n      streamId: this.id,\n      streamType: 'final',\n    });\n  }\n}\n\n/**\n * options for adding a mention\n * to an activity\n */\nexport type AddMentionOptions = {\n  /**\n   * if `true`, append the mention `text` to the `activity.text`\n   * @default true\n   */\n  readonly addText?: boolean;\n\n  /**\n   * the `text` to use for the mention\n   *\n   * @default `account.name`\n   * @remark\n   * this text should not include `<at>` or `</at>`\n   */\n  readonly text?: string;\n};\n"]}

package/dist/activities/trace.d.mts

@@ -0,0 +1,46 @@
+import { ConversationReference } from '../models/conversation/conversation-reference.mjs';
+import { IActivity } from './activity.mjs';
+import '../models/account.mjs';
+import '../models/role.mjs';
+import '../models/channel-id.mjs';
+import '../models/entity/index.mjs';
+import '../models/entity/ai-message-entity.mjs';
+import '../models/entity/citation-entity.mjs';
+import '../models/entity/sensitive-usage-entity.mjs';
+import '../models/entity/client-info-entity.mjs';
+import '../models/entity/mention-entity.mjs';
+import '../models/entity/message-entity.mjs';
+import '../models/entity/stream-info-entity.mjs';
+import '../models/channel-data/index.mjs';
+import '../models/meeting/meeting-info.mjs';
+import '../models/meeting/meeting-details.mjs';
+import '../models/channel-data/channel-info.mjs';
+import '../models/channel-data/notification-info.mjs';
+import '../models/channel-data/settings.mjs';
+import '../models/channel-data/team-info.mjs';
+import '../models/channel-data/tenant-info.mjs';
+
+interface ITraceActivity extends IActivity<'trace'> {
+    /**
+     * The name of the operation associated with an invoke or event activity.
+     */
+    name?: string;
+    /**
+     * A descriptive label for the activity.
+     */
+    label: string;
+    /**
+     * The type of the activity's value object.
+     */
+    valueType: string;
+    /**
+     * A value that is associated with the activity.
+     */
+    value?: any;
+    /**
+     * A reference to another conversation or activity.
+     */
+    relatesTo?: ConversationReference;
+}
+
+export type { ITraceActivity };