@assistant-ui/react-generative-ui 0.0.24 → 0.1.0

package/src/teams/toTeamsAttachments.test.ts

@@ -1,74 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { toTeamsAttachments } from "./toTeamsAttachments";
-import { PAYLOAD_SOFT_CAP } from "./constants";
-
-describe("toTeamsAttachments payload budget", () => {
-  it("warns on the aggregate carousel size even when no single card exceeds the soft cap", () => {
-    const value = "x".repeat(45000);
-    const { attachments, warnings } = toTeamsAttachments({
-      $type: "Carousel",
-      children: [
-        { $type: "Card", title: "A", children: { $type: "Markdown", value } },
-        { $type: "Card", title: "B", children: { $type: "Markdown", value } },
-      ],
-    });
-    for (const attachment of attachments) {
-      expect(JSON.stringify(attachment.content).length).toBeLessThanOrEqual(
-        PAYLOAD_SOFT_CAP,
-      );
-    }
-    expect(
-      warnings.some(
-        (warning) =>
-          warning.code === "advisory" && warning.component === "Root",
-      ),
-    ).toBe(false);
-    expect(warnings).toContainEqual(
-      expect.objectContaining({
-        code: "advisory",
-        component: "Carousel",
-        detail: expect.stringContaining(
-          `over the ${PAYLOAD_SOFT_CAP}-byte soft budget`,
-        ),
-      }),
-    );
-  });
-});
-
-describe("toTeamsAttachments root carousel children", () => {
-  it("reports a renderable non-card child instead of dropping it silently", () => {
-    const { attachments, warnings } = toTeamsAttachments({
-      $type: "Carousel",
-      children: [
-        { $type: "Text", value: "lost" },
-        { $type: "Card", title: "kept" },
-      ],
-    });
-    expect(attachments).toHaveLength(1);
-    expect(warnings).toContainEqual({
-      code: "dropped",
-      component: "Carousel",
-      detail: "1 non-card child was dropped.",
-    });
-  });
-
-  it("forwards a discarded child's own dropped warning", () => {
-    const { warnings } = toTeamsAttachments({
-      $type: "Carousel",
-      children: [{ $type: "Mystery" }, { $type: "Card", title: "kept" }],
-    });
-    expect(warnings).toContainEqual({
-      code: "dropped",
-      component: "Mystery",
-      detail: "Unknown component type was dropped.",
-    });
-  });
-
-  it("stays silent for a child that renders nothing anyway", () => {
-    const { warnings } = toTeamsAttachments({
-      $type: "Carousel",
-      children: [{ $type: "Spacer" }, { $type: "Card", title: "kept" }],
-    });
-    expect(warnings).toEqual([]);
-  });
-});

package/src/teams/toTeamsAttachments.ts

@@ -1,133 +0,0 @@
-import { boundSpec, clampReasonDetail } from "../convert/boundSpec";
-import { copyBounded } from "../convert/copyBounded";
-import { isElement } from "../convert/isElement";
-import {
-  normalizeSpec,
-  type NormalizedUIElement,
-  type NormalizedUINode,
-} from "../ir";
-import {
-  CAROUSEL_ATTACHMENT_CAP,
-  PAYLOAD_SOFT_CAP,
-  buildAttachment,
-  utf8ByteLength,
-} from "./constants";
-import {
-  convertRootToCard,
-  discardedChild,
-  type ConversionContext,
-} from "./toAdaptiveCard";
-import type {
-  TeamsAttachmentsResult,
-  TeamsCardAttachment,
-  TeamsConversionWarning,
-  ToAdaptiveCardOptions,
-} from "./types";
-
-const normalizedList = (
-  node: NormalizedUINode | undefined,
-): NormalizedUINode[] => {
-  if (node === undefined || node === null) return [];
-  if (!Array.isArray(node)) return [node];
-  return node.flatMap((child) => normalizedList(child));
-};
-
-/**
- * Recognizes a root that is a single `Carousel` element, returning its `Card`
- * children. A non-card child is routed through {@link discardedChild}, which
- * reports it and forwards whatever it lost, rather than being filtered out
- * silently. `undefined` means the root is not exclusively a
- * root-level carousel, so the caller falls back to converting the whole tree
- * as one card.
- */
-function rootCarouselCards(
-  root: NormalizedUINode | readonly NormalizedUINode[],
-  context: ConversionContext,
-): NormalizedUIElement[] | undefined {
-  const element = Array.isArray(root) && root.length === 1 ? root[0] : root;
-  if (!isElement(element) || element.type !== "Carousel") return undefined;
-  const cards: NormalizedUIElement[] = [];
-  let discarded = 0;
-  for (const child of normalizedList(element.children)) {
-    if (isElement(child) && child.type === "Card") {
-      cards.push(child);
-      continue;
-    }
-    if (discardedChild(child, context, 1)) discarded += 1;
-  }
-  if (discarded > 0) {
-    context.warnings.push({
-      code: "dropped",
-      component: "Carousel",
-      detail: `${discarded} non-card ${discarded === 1 ? "child was" : "children were"} dropped.`,
-    });
-  }
-  return cards;
-}
-
-/**
- * Converts a generative-ui tree into Teams bot-framework message attachments.
- * A root-level `Carousel` becomes one attachment per `Card` child (clamped to
- * {@link CAROUSEL_ATTACHMENT_CAP}) with `attachmentLayout: "carousel"`;
- * anything else converts through {@link toAdaptiveCard}'s engine into a
- * single attachment. Never throws.
- */
-export function toTeamsAttachments(
-  node: unknown,
-  _options?: ToAdaptiveCardOptions,
-): TeamsAttachmentsResult {
-  const warnings: TeamsConversionWarning[] = [];
-  const context: ConversionContext = {
-    warnings,
-    usedInputIds: new Set(),
-  };
-  try {
-    const bounded = boundSpec(node, (reason) =>
-      warnings.push({
-        code: "clamped",
-        component: "Root",
-        detail: clampReasonDetail(reason),
-      }),
-    );
-    const { root } = normalizeSpec(bounded as never);
-    const carouselCards = rootCarouselCards(root, context);
-    if (carouselCards !== undefined) {
-      const { items, truncated } = copyBounded(
-        carouselCards,
-        CAROUSEL_ATTACHMENT_CAP,
-      );
-      if (truncated) {
-        warnings.push({
-          code: "clamped",
-          component: "Carousel",
-          detail: `cards were clamped to ${CAROUSEL_ATTACHMENT_CAP} entries.`,
-        });
-      }
-      const attachments: TeamsCardAttachment[] = items.map((child) =>
-        buildAttachment(convertRootToCard(child, context)),
-      );
-      const size = utf8ByteLength(JSON.stringify(attachments));
-      if (size > PAYLOAD_SOFT_CAP) {
-        warnings.push({
-          code: "advisory",
-          component: "Carousel",
-          detail: `the carousel attachments total ${size} bytes, over the ${PAYLOAD_SOFT_CAP}-byte soft budget kept below Teams' 100 KB bot message limit.`,
-        });
-      }
-      return { attachments, attachmentLayout: "carousel", warnings };
-    }
-    const attachment = buildAttachment(convertRootToCard(root, context));
-    return { attachments: [attachment], warnings };
-  } catch {
-    return {
-      attachments: [],
-      warnings: [
-        {
-          code: "dropped",
-          component: "Root",
-          detail: "Input could not be converted.",
-        },
-      ],
-    };
-  }
-}

package/src/teams/types.ts

@@ -1,266 +0,0 @@
-/** A TextBlock size, from Adaptive Card's closed size enum. */
-export type TeamsTextSize = "small" | "medium" | "large" | "extraLarge";
-
-/** A Container's style, driving its accent color in Teams' renderer. */
-export type TeamsContainerStyle =
-  | "default"
-  | "emphasis"
-  | "good"
-  | "attention"
-  | "warning"
-  | "accent";
-
-/** A run of wrapped text. Every TextBlock we emit sets `wrap: true`. */
-export interface TeamsTextBlock {
-  readonly type: "TextBlock";
-  readonly text: string;
-  readonly wrap: true;
-  readonly size?: TeamsTextSize;
-  readonly weight?: "bolder";
-  readonly style?: "heading";
-  readonly isSubtle?: true;
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** An image element. */
-export interface TeamsImage {
-  readonly type: "Image";
-  readonly url: string;
-  readonly altText?: string;
-  readonly size?: "small" | "medium" | "large";
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** One label/value entry inside a {@link TeamsFactSet}. */
-export interface TeamsFact {
-  readonly title: string;
-  readonly value: string;
-}
-
-/** A set of label/value facts, rendered as an aligned two-column list. */
-export interface TeamsFactSet {
-  readonly type: "FactSet";
-  readonly facts: readonly TeamsFact[];
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** The `aui` envelope nested inside every {@link TeamsSubmitAction}'s `data`. */
-export interface TeamsSubmitData {
-  readonly aui: {
-    readonly type: string;
-    readonly payload?: Record<string, unknown>;
-  };
-}
-
-export type TeamsTemporalField = { readonly fieldId: string } & (
-  | { readonly role: "date" }
-  | { readonly role: "time"; readonly previousValue?: string }
-);
-
-/**
- * A submit action. `data` carries the resume payload under an `aui` key so
- * {@link decodeSubmitData} can invert it out of the merged `activity.value`
- * a Teams bot receives, alongside whatever other named inputs shared the card.
- */
-export interface TeamsSubmitAction {
-  readonly type: "Action.Submit";
-  readonly title: string;
-  readonly data: TeamsSubmitData;
-  readonly mode?: "secondary";
-}
-
-/** The action shape accepted at the card's top-level `actions` field. */
-export type TeamsCardAction = TeamsSubmitAction;
-
-/** A bar of submit actions, rendered inline in the body flow. */
-export interface TeamsActionSet {
-  readonly type: "ActionSet";
-  readonly actions: readonly TeamsSubmitAction[];
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** A bordered grouping container. */
-export interface TeamsContainer {
-  readonly type: "Container";
-  readonly style?: TeamsContainerStyle;
-  readonly items: readonly TeamsCardElement[];
-  readonly selectAction?: TeamsSubmitAction;
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** One column inside a {@link TeamsColumnSet}. */
-export interface TeamsColumn {
-  readonly type: "Column";
-  readonly width: "auto";
-  readonly items: readonly TeamsCardElement[];
-}
-
-/** A horizontal row of columns. */
-export interface TeamsColumnSet {
-  readonly type: "ColumnSet";
-  readonly columns: readonly TeamsColumn[];
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** One selectable choice inside a {@link TeamsInputChoiceSet}. */
-export interface TeamsInputChoice {
-  readonly title: string;
-  readonly value: string;
-}
-
-/** A dropdown (`compact`), radio group (`expanded`), or checkbox group (`expanded` with `isMultiSelect`) input. */
-export interface TeamsInputChoiceSet {
-  readonly type: "Input.ChoiceSet";
-  readonly id: string;
-  readonly style: "compact" | "expanded";
-  readonly isMultiSelect?: true;
-  readonly choices: readonly TeamsInputChoice[];
-  readonly placeholder?: string;
-  readonly label?: string;
-  readonly value?: string;
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** A checkbox-shaped boolean input. */
-export interface TeamsInputToggle {
-  readonly type: "Input.Toggle";
-  readonly id: string;
-  readonly title: string;
-  readonly value: "true" | "false";
-  readonly valueOn: "true";
-  readonly valueOff: "false";
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** A single or multi-line text input. */
-export interface TeamsInputText {
-  readonly type: "Input.Text";
-  readonly id: string;
-  readonly style?: "password";
-  readonly label?: string;
-  readonly placeholder?: string;
-  readonly value?: string;
-  readonly isMultiline?: true;
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** A date input, restricted to `YYYY-MM-DD` values. */
-export interface TeamsInputDate {
-  readonly type: "Input.Date";
-  readonly id: string;
-  readonly label?: string;
-  readonly value?: string;
-  readonly min?: string;
-  readonly max?: string;
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-export interface TeamsInputTime {
-  readonly type: "Input.Time";
-  readonly id: string;
-  readonly label?: string;
-  readonly value?: string;
-  readonly min?: string;
-  readonly max?: string;
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** One cell inside a {@link TeamsTableRow}. */
-export interface TeamsTableCell {
-  readonly type: "TableCell";
-  readonly items: readonly TeamsTextBlock[];
-}
-
-/** One row inside a {@link TeamsTable}. */
-export interface TeamsTableRow {
-  readonly type: "TableRow";
-  readonly cells: readonly TeamsTableCell[];
-}
-
-/** A column width definition inside a {@link TeamsTable}. */
-export interface TeamsTableColumnDefinition {
-  readonly width: 1;
-}
-
-/** A native table. `rows[0]` is the header row when `firstRowAsHeaders` is true. */
-export interface TeamsTable {
-  readonly type: "Table";
-  readonly firstRowAsHeaders: boolean;
-  readonly columns: readonly TeamsTableColumnDefinition[];
-  readonly rows: readonly TeamsTableRow[];
-  readonly separator?: true;
-  readonly spacing?: "large";
-}
-
-/** A body element emitted by {@link toAdaptiveCard}. */
-export type TeamsCardElement =
-  | TeamsTextBlock
-  | TeamsImage
-  | TeamsFactSet
-  | TeamsActionSet
-  | TeamsContainer
-  | TeamsColumnSet
-  | TeamsInputChoiceSet
-  | TeamsInputToggle
-  | TeamsInputText
-  | TeamsInputDate
-  | TeamsInputTime
-  | TeamsTable;
-
-/** A Microsoft Teams Adaptive Card, pinned to schema version 1.5 (the Teams desktop/web cap; mobile clients cap at 1.2). */
-export interface TeamsAdaptiveCard {
-  readonly $schema: "http://adaptivecards.io/schemas/adaptive-card.json";
-  readonly type: "AdaptiveCard";
-  readonly version: "1.5";
-  readonly body: readonly TeamsCardElement[];
-  readonly actions: readonly TeamsCardAction[];
-}
-
-/** An Adaptive Card wrapped as a bot-framework message attachment. */
-export interface TeamsCardAttachment {
-  readonly contentType: "application/vnd.microsoft.card.adaptive";
-  readonly content: TeamsAdaptiveCard;
-}
-
-/**
- * A non-fatal note reported during Teams conversion.
- *
- * `clamped` removed content to fit a limit, `dropped` discarded a node or one
- * of its props and may leave a placeholder note behind, and `fallback`
- * emitted the node in a different form than requested. `advisory` changed
- * nothing at all and notes content Teams may still render poorly or refuse,
- * such as a payload over the byte budget or a `Row` past the recommended
- * column count.
- */
-export interface TeamsConversionWarning {
-  readonly code: "clamped" | "dropped" | "fallback" | "advisory";
-  readonly component: string;
-  readonly detail: string;
-}
-
-/** Options accepted by {@link toAdaptiveCard} and {@link toTeamsAttachments}. Reserved for future extension; no options are currently defined. */
-export interface ToAdaptiveCardOptions {}
-
-/** The card and non-fatal warnings produced by {@link toAdaptiveCard}. */
-export interface AdaptiveCardResult {
-  readonly card: TeamsAdaptiveCard;
-  readonly warnings: TeamsConversionWarning[];
-}
-
-/** The attachments and non-fatal warnings produced by {@link toTeamsAttachments}. */
-export interface TeamsAttachmentsResult {
-  readonly attachments: TeamsCardAttachment[];
-  readonly attachmentLayout?: "carousel";
-  readonly warnings: TeamsConversionWarning[];
-}