chat 3.0.0 → 4.0.1

package/dist/jsx-runtime-D7zHSnXe.d.ts

@@ -0,0 +1,349 @@
+/**
+ * Card elements for cross-platform rich messaging.
+ *
+ * Provides a builder API for creating rich cards that automatically
+ * convert to platform-specific formats:
+ * - Slack: Block Kit
+ * - Teams: Adaptive Cards
+ * - Google Chat: Card v2
+ *
+ * Supports both function-call and JSX syntax:
+ *
+ * @example Function API
+ * ```ts
+ * import { Card, Text, Actions, Button } from "chat";
+ *
+ * await thread.post(
+ *   Card({
+ *     title: "Order #1234",
+ *     children: [
+ *       Text("Total: $50.00"),
+ *       Actions([
+ *         Button({ id: "approve", label: "Approve", style: "primary" }),
+ *         Button({ id: "reject", label: "Reject", style: "danger" }),
+ *       ]),
+ *     ],
+ *   })
+ * );
+ * ```
+ *
+ * @example JSX API (requires jsxImportSource: "chat" in tsconfig)
+ * ```tsx
+ * /** @jsxImportSource chat *\/
+ * import { Card, Text, Actions, Button } from "chat";
+ *
+ * await thread.post(
+ *   <Card title="Order #1234">
+ *     <Text>Total: $50.00</Text>
+ *     <Actions>
+ *       <Button id="approve" style="primary">Approve</Button>
+ *       <Button id="reject" style="danger">Reject</Button>
+ *     </Actions>
+ *   </Card>
+ * );
+ * ```
+ */
+/** Button style options */
+type ButtonStyle = "primary" | "danger" | "default";
+/** Text style options */
+type TextStyle = "plain" | "bold" | "muted";
+/** Button element for interactive actions */
+interface ButtonElement {
+    type: "button";
+    /** Unique action ID for callback routing */
+    id: string;
+    /** Button label text */
+    label: string;
+    /** Visual style */
+    style?: ButtonStyle;
+    /** Optional payload value sent with action callback */
+    value?: string;
+}
+/** Text content element */
+interface TextElement {
+    type: "text";
+    /** Text content (supports markdown in some platforms) */
+    content: string;
+    /** Text style */
+    style?: TextStyle;
+}
+/** Image element */
+interface ImageElement {
+    type: "image";
+    /** Image URL */
+    url: string;
+    /** Alt text for accessibility */
+    alt?: string;
+}
+/** Visual divider/separator */
+interface DividerElement {
+    type: "divider";
+}
+/** Container for action buttons */
+interface ActionsElement {
+    type: "actions";
+    /** Button elements */
+    children: ButtonElement[];
+}
+/** Section container for grouping elements */
+interface SectionElement {
+    type: "section";
+    /** Section children */
+    children: CardChild[];
+}
+/** Field for key-value display */
+interface FieldElement {
+    type: "field";
+    /** Field label */
+    label: string;
+    /** Field value */
+    value: string;
+}
+/** Fields container for multi-column layout */
+interface FieldsElement {
+    type: "fields";
+    /** Field elements */
+    children: FieldElement[];
+}
+/** Union of all card child element types */
+type CardChild = TextElement | ImageElement | DividerElement | ActionsElement | SectionElement | FieldsElement;
+/** Union of all element types (including nested children) */
+type AnyCardElement = CardChild | CardElement | ButtonElement | FieldElement;
+/** Root card element */
+interface CardElement {
+    type: "card";
+    /** Card title */
+    title?: string;
+    /** Card subtitle */
+    subtitle?: string;
+    /** Header image URL */
+    imageUrl?: string;
+    /** Card content */
+    children: CardChild[];
+}
+/** Type guard for CardElement */
+declare function isCardElement(value: unknown): value is CardElement;
+/** Options for Card */
+interface CardOptions {
+    title?: string;
+    subtitle?: string;
+    imageUrl?: string;
+    children?: CardChild[];
+}
+/**
+ * Create a Card element.
+ *
+ * @example
+ * ```ts
+ * Card({
+ *   title: "Welcome",
+ *   children: [Text("Hello!")],
+ * })
+ * ```
+ */
+declare function Card(options?: CardOptions): CardElement;
+/**
+ * Create a Text element.
+ *
+ * @example
+ * ```ts
+ * Text("Hello, world!")
+ * Text("Important", { style: "bold" })
+ * ```
+ */
+declare function Text(content: string, options?: {
+    style?: TextStyle;
+}): TextElement;
+/**
+ * Create an Image element.
+ *
+ * @example
+ * ```ts
+ * Image({ url: "https://example.com/image.png", alt: "Description" })
+ * ```
+ */
+declare function Image(options: {
+    url: string;
+    alt?: string;
+}): ImageElement;
+/**
+ * Create a Divider element.
+ *
+ * @example
+ * ```ts
+ * Divider()
+ * ```
+ */
+declare function Divider(): DividerElement;
+/**
+ * Create a Section container.
+ *
+ * @example
+ * ```ts
+ * Section([
+ *   Text("Grouped content"),
+ *   Image({ url: "..." }),
+ * ])
+ * ```
+ */
+declare function Section(children: CardChild[]): SectionElement;
+/**
+ * Create an Actions container for buttons.
+ *
+ * @example
+ * ```ts
+ * Actions([
+ *   Button({ id: "ok", label: "OK" }),
+ *   Button({ id: "cancel", label: "Cancel" }),
+ * ])
+ * ```
+ */
+declare function Actions(children: ButtonElement[]): ActionsElement;
+/** Options for Button */
+interface ButtonOptions {
+    /** Unique action ID for callback routing */
+    id: string;
+    /** Button label text */
+    label: string;
+    /** Visual style */
+    style?: ButtonStyle;
+    /** Optional payload value sent with action callback */
+    value?: string;
+}
+/**
+ * Create a Button element.
+ *
+ * @example
+ * ```ts
+ * Button({ id: "submit", label: "Submit", style: "primary" })
+ * Button({ id: "delete", label: "Delete", style: "danger", value: "item-123" })
+ * ```
+ */
+declare function Button(options: ButtonOptions): ButtonElement;
+/**
+ * Create a Field element for key-value display.
+ *
+ * @example
+ * ```ts
+ * Field({ label: "Status", value: "Active" })
+ * ```
+ */
+declare function Field(options: {
+    label: string;
+    value: string;
+}): FieldElement;
+/**
+ * Create a Fields container for multi-column layout.
+ *
+ * @example
+ * ```ts
+ * Fields([
+ *   Field({ label: "Name", value: "John" }),
+ *   Field({ label: "Email", value: "john@example.com" }),
+ * ])
+ * ```
+ */
+declare function Fields(children: FieldElement[]): FieldsElement;
+/**
+ * Convert a React element tree to a CardElement tree.
+ * This allows using React's JSX with our card components.
+ *
+ * @example
+ * ```tsx
+ * import React from "react";
+ * import { Card, Text, fromReactElement } from "chat";
+ *
+ * const element = (
+ *   <Card title="Hello">
+ *     <Text>World</Text>
+ *   </Card>
+ * );
+ *
+ * const card = fromReactElement(element);
+ * await thread.post(card);
+ * ```
+ */
+declare function fromReactElement(element: unknown): AnyCardElement | null;
+
+/**
+ * Custom JSX runtime for chat cards.
+ *
+ * This allows using JSX syntax without React. Configure your bundler:
+ *
+ * tsconfig.json:
+ * {
+ *   "compilerOptions": {
+ *     "jsx": "react-jsx",
+ *     "jsxImportSource": "chat"
+ *   }
+ * }
+ *
+ * Or per-file:
+ * /** @jsxImportSource chat *\/
+ *
+ * Usage:
+ * ```tsx
+ * import { Card, Text, Button, Actions } from "chat";
+ *
+ * const card = (
+ *   <Card title="Order #1234">
+ *     <Text>Your order is ready!</Text>
+ *     <Actions>
+ *       <Button id="pickup" style="primary">Schedule Pickup</Button>
+ *     </Actions>
+ *   </Card>
+ * );
+ * ```
+ */
+
+declare const JSX_ELEMENT: unique symbol;
+/**
+ * Represents a JSX element from the chat JSX runtime.
+ * This is the type returned when using JSX syntax with chat components.
+ */
+interface CardJSXElement {
+    $$typeof: typeof JSX_ELEMENT;
+    type: CardComponentFunction;
+    props: Record<string, unknown>;
+    children: unknown[];
+}
+type JSXElement = CardJSXElement;
+type CardComponentFunction = (...args: any[]) => CardElement | CardChild;
+/**
+ * JSX factory function (used by the JSX transform).
+ * Creates a lazy JSX element that will be resolved when needed.
+ */
+declare function jsx(type: CardComponentFunction, props: Record<string, unknown>, _key?: string): JSXElement;
+/**
+ * JSX factory for elements with multiple children.
+ */
+declare function jsxs(type: CardComponentFunction, props: Record<string, unknown>, _key?: string): JSXElement;
+/**
+ * Development JSX factory (same as jsx, but called in dev mode).
+ */
+declare const jsxDEV: typeof jsx;
+/**
+ * Fragment support (flattens children).
+ */
+declare function Fragment(props: {
+    children?: unknown;
+}): CardChild[];
+/**
+ * Convert a JSX element tree to a CardElement.
+ * Call this on the root JSX element to get a usable CardElement.
+ */
+declare function toCardElement(jsxElement: unknown): CardElement | null;
+/**
+ * Check if a value is a JSX element (from our runtime or React).
+ */
+declare function isJSX(value: unknown): boolean;
+declare namespace JSX {
+    interface Element extends JSXElement {
+    }
+    type IntrinsicElements = {};
+    interface ElementChildrenAttribute {
+        children: {};
+    }
+}
+
+export { Actions as A, Button as B, type CardElement as C, Divider as D, Field as F, Image as I, JSX as J, Section as S, Text as T, type CardJSXElement as a, type CardChild as b, Card as c, Fields as d, isJSX as e, fromReactElement as f, type ActionsElement as g, type ButtonElement as h, isCardElement as i, type ButtonOptions as j, type ButtonStyle as k, type CardOptions as l, type DividerElement as m, type FieldElement as n, type FieldsElement as o, type ImageElement as p, type SectionElement as q, type TextElement as r, type TextStyle as s, toCardElement as t, jsx as u, jsxs as v, jsxDEV as w, Fragment as x };

package/dist/jsx-runtime.d.ts

@@ -0,0 +1 @@
+export { a as CardJSXElement, x as Fragment, J as JSX, e as isJSX, u as jsx, w as jsxDEV, v as jsxs, t as toCardElement } from './jsx-runtime-D7zHSnXe.js';

package/dist/jsx-runtime.js

@@ -0,0 +1,17 @@
+import {
+  Fragment,
+  isJSX,
+  jsx,
+  jsxDEV,
+  jsxs,
+  toCardElement
+} from "./chunk-ACQNDPTB.js";
+export {
+  Fragment,
+  isJSX,
+  jsx,
+  jsxDEV,
+  jsxs,
+  toCardElement
+};
+//# sourceMappingURL=jsx-runtime.js.map

package/dist/jsx-runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,4 +1,71 @@
 {
   "name": "chat",
-  "version": "3.0.0"
-}
+  "version": "4.0.1",
+  "description": "Unified chat abstraction for Slack, Teams, Google Chat, and Discord",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./jsx-runtime": {
+      "types": "./dist/jsx-runtime.d.ts",
+      "import": "./dist/jsx-runtime.js"
+    },
+    "./jsx-dev-runtime": {
+      "types": "./dist/jsx-runtime.d.ts",
+      "import": "./dist/jsx-runtime.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "unified": "^11.0.5",
+    "remark-parse": "^11.0.0",
+    "remark-stringify": "^11.0.0",
+    "remark-gfm": "^4.0.0",
+    "mdast-util-to-string": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "@types/mdast": "^4.0.4",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "peerDependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vercel-labs/chat.git",
+    "directory": "packages/chat-sdk"
+  },
+  "homepage": "https://github.com/vercel-labs/chat#readme",
+  "bugs": {
+    "url": "https://github.com/vercel-labs/chat/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "chat",
+    "slack",
+    "teams",
+    "discord",
+    "google-chat",
+    "bot"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "rm -rf dist && tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check src",
+    "clean": "rm -rf dist"
+  }
+}

package/readme.md

@@ -1 +0,0 @@
-# chat