@dbx-tools/ 共享团队

验证微软团队的适应卡和瓶子框架活动有效载荷 浏览器和服务器代码. 它定义了共享的Zod计划,推断类型, 附加辅助器和常数。 这个 @dbx-工具/团队 服务器包构建这些有效载荷,以及 @dbx-tools/ui-teams (英语) 让他们.

快开始

import { card } from "@dbx-tools/shared-teams";

const spec = card.cardSpecSchema.parse({
  title: "Deployment succeeded",
  text: "The API service rolled out cleanly.",
});

利用这些合同和建筑商:

• 高级别 CardSpec 合同:小的、方便模型的词汇是一个模型 草案(标题、字幕、文本、事实、联系行动)而不是手写 原始适配卡JSON.
• AdaptiveCard 用于编译的可调适卡 1.5文档的封装方案 adaptivecards 变相器消耗 团队接受.
• CardResult 构建响应的计划返回到模型或浏览器中.
• Activity 对话终点合同: Bot 框架信封 a 团队频道交换,与 CardAttachment 标记卡为 application/vnd.microsoft.card.adaptive,加上 toCardAttachment 编号 : cardsOf 帮助双方使用此附件 同样的。 未知的活动区得到保留而不是剥去 因为一个真实的频道发送远不止这个软件包读取.
• 避免JSON Schema限制的模型/工具友好计划 一些服务端点的问题( 无数组) minItems) (中文(简体) ).

验证卡片字段

import { card, type CardSpec } from "@dbx-tools/shared-teams";

const spec: CardSpec = card.cardSpecSchema.parse({
  title: "Deployment succeeded",
  subtitle: "prod • 2m ago",
  text: "The **api** service rolled out cleanly.",
  facts: [
    { title: "Version", value: "1.4.2" },
    { title: "Owner", value: "alice" },
  ],
  actions: [{ title: "View run", url: "https://example.com/runs/42" }],
});

Spec schema是故意小的 所以一个模型产生有效的输入 而不是免费卡 JSON 制造者会拒绝.

验证已编译的卡片

const result = card.cardResultSchema.parse(await response.json());
// result.card is a full Adaptive Card document ready to render or post to Teams.

adaptiveCardSchema 验证通用信封字段 : type, (中文(简体) ), $schema, (中文(简体) ), version,以及 body。在 @dbx-工具/团队 定义内部的确切元素形状 body 财务报告和审定财务报表 actions。 。 。 .

运行时边界

此软件包不渲染出卡, 运行代理, 验证 Microsoft Bot 框架 或贴给团队。 使用 @dbx-工具/团队 这些 服务器操作和 @dbx-tools/ui-teams (英语) 用于反应 翻译.

软件包出口

• card数字 : cardFactSchema, (中文(简体) ), cardActionSchema, (中文(简体) ), cardSpecSchema, (中文(简体) ), adaptiveCardSchema, (中文(简体) ), cardResultSchema,则 ADAPTIVE_CARD_VERSION 编号 : ADAPTIVE_CARD_SCHEMA_URL 常数和平方推断类型: CardFact, (中文(简体) ), CardAction, (中文(简体) ), CardSpec, (中文(简体) ), AdaptiveCard,以及 CardResult。 。 。 .
• teamsActivity数字 : activitySchema, (中文(简体) ), activityRequestSchema, (中文(简体) ), activityResponseSchema, (中文(简体) ), cardAttachmentSchema, (中文(简体) ), channelAccountSchema, (中文(简体) ), conversationAccountSchema,则 ADAPTIVE_CARD_CONTENT_TYPE 编号 : ACTIVITY_TYPES 常数 toCardAttachment 编号 : cardsOf 帮助者,和 页:1 Activity, (中文(简体) ), ActivityRequest, (中文(简体) ), ActivityResponse, (中文(简体) ), CardAttachment, (中文(简体) ), ChannelAccount, (中文(简体) ), ConversationAccount,以及 ActivityType 类型.

故意避免阵列 .min() 限制,使其可以再利用 作为JSON为拒绝的终点服务的模型/工具 minItems。 。 。 .