heiwa4126-twpost (@heiwa4126/twpost)


English | 日本語

A package of functions for posting messages in Adaptive Cards format to webhooks created from the "Post to chat when a webhook request is received" template in Teams Workflows (Teams version of Power Automate).

twpost stands for "Teams Webhook Post".

Installation

``sh
npm install @heiwa4126/twpost
`

Usage

$3

`typescript
import { postText, displayWebhookResult } from "@heiwa4126/twpost";

const webhookUrl = "Your Teams Webhook URL";
const result = await postText(webhookUrl, "Hello! from my application!");
displayWebhookResult(result);
`

$3

Create Adaptive Cards type-safely using @microsoft/teams.cards:

`typescript
import { postCard, displayWebhookResult, SCHEMA_URL } from "@heiwa4126/twpost";
import { AdaptiveCard, DonutChart, DonutChartData, TextBlock } from "@microsoft/teams.cards";

const card = new AdaptiveCard(
new TextBlock("Results Announcement", {
wrap: true,
size: "Large",
}),
new DonutChart({
title: "Sales Data",
}).withData(
new DonutChartData({ legend: "Banana", value: 292 }),
new DonutChartData({ legend: "Kiwi", value: 179 }),
new DonutChartData({ legend: "Apple", value: 143 })
)
).withOptions({
version: "1.5",
$schema: SCHEMA_URL,
});

const result = await postCard(webhookUrl, card);
displayWebhookResult(result);
`

$3

Use JSON created directly with Adaptive Card Designer:

`typescript
import { postRawCard, displayWebhookResult, SCHEMA_URL } from "@heiwa4126/twpost";

const rawCard = {
type: "AdaptiveCard",
$schema: SCHEMA_URL,
version: "1.5",
body: [
{
type: "TextBlock",
wrap: true,
text: "Processing started (ID=USO800)",
},
{
type: "ProgressRing", // Not in the latest schema but renders in Teams
label: "Processing...",
labelPosition: "After",
size: "Tiny",
},
],
actions: [
{
type: "Action.OpenUrl",
title: "Cancel",
url: "https://api.example.com/cancel?id=uso800",
},
],
};

const result = await postRawCard(webhookUrl, rawCard);
displayWebhookResult(result);
`

$3

Leverage type checking while handling schema-missing elements with type casting:

`typescript
import { postCard, displayWebhookResult, SCHEMA_URL } from "@heiwa4126/twpost";
import type { IAdaptiveCard } from "@microsoft/teams.cards";

const card: IAdaptiveCard = {
type: "AdaptiveCard",
$schema: SCHEMA_URL,
version: "1.5",
body: [
{
type: "TextBlock",
wrap: true,
text: "Processing started (ID=USO800)",
},
// ProgressRing is not in the latest schema but renders in Teams
// Use unknown cast to bypass type checking
{
type: "ProgressRing",
label: "Processing...",
labelPosition: "After",
size: "Tiny",
} as unknown as IAdaptiveCard["body"][0],
],
actions: [
{
type: "Action.OpenUrl",
iconUrl: "icon:CalendarCancel",
style: "destructive",
title: "Cancel",
url: "https://api.example.com/cancel?id=uso800",
},
{
type: "Action.OpenUrl",
title: "Process Description",
url: "https://api.example.com/description?id=uso800",
},
],
};

const result = await postCard(webhookUrl, card);
displayWebhookResult(result);
`

API Reference

$3

Sends a simple text message. Supports limited Markdown.

$3

Sends an Adaptive Card with type checking.

$3

Sends an object directly as Adaptive Card format. No validation is performed.

$3

Displays response information to the console.

Notes

- The JSON schema for @microsoft/teams.cards is not complete and may not include element types that are actually available in Teams
- For new element types (e.g., ProgressRing), use postRawCard() or perform type casting. See example/ex4.ts for casting examples.

Development

Getting started:

`sh
npm run init # Not npm init
npm run smoketest
npm install @microsoft/teams.cards # if needed
``

License

MIT License