@copilotkit/channels-ui 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,212 @@
+import type { EmojiValue } from "./emoji.js";
+import type { ModalView } from "./modal.js";
+import type { Renderable } from "./ir.js";
+export interface MessageRef {
+    id: string;
+    [k: string]: unknown;
+}
+/** Result of `Thread.postEphemeral`. `usedFallback` is present on success: `false` = native, `true` = DM fallback. */
+export interface EphemeralResult {
+    ok: boolean;
+    usedFallback?: boolean;
+    ref?: MessageRef;
+    error?: string;
+}
+export interface PlatformUser {
+    id: string;
+    name?: string;
+    handle?: string;
+    email?: string;
+}
+/** A base64 data source, shared by every binary media part. */
+export type MediaDataSource = {
+    type: "data";
+    value: string;
+    mimeType: string;
+};
+/**
+ * AG-UI multimodal content parts. Defined here (the lowest shared layer) so
+ * platform adapters can carry built multimodal content through the framework
+ * to the agent without a circular dependency — `@copilotkit/channels` depends on
+ * `@copilotkit/channels-ui`, not the reverse. Identical in shape to bot-slack's so
+ * the agent sees the same multimodal input across every adapter.
+ *
+ * Binary media (image/audio/video/document) is passed straight through as a
+ * data part; the agent's model decides what it can actually consume.
+ */
+export type AgentContentPart = {
+    type: "text";
+    text: string;
+} | {
+    type: "image";
+    source: MediaDataSource;
+} | {
+    type: "audio";
+    source: MediaDataSource;
+} | {
+    type: "video";
+    source: MediaDataSource;
+} | {
+    type: "document";
+    source: MediaDataSource;
+};
+export interface IncomingMessage {
+    text: string;
+    user: PlatformUser;
+    ref: MessageRef;
+    platform: string;
+    /**
+     * Optional multimodal content parts (e.g. inbound image/file attachments)
+     * built by the adapter. When present, the app should prefer these over
+     * `text` as the agent prompt so the model receives the attachments.
+     */
+    contentParts?: AgentContentPart[];
+    /**
+     * Cross-platform identity key resolved by the bot's `identity` resolver, if
+     * any. Stable across platforms for the same human (e.g. an email address).
+     */
+    userKey?: string;
+    /**
+     * Stable platform event id (managed/Intelligence path), for customer-side
+     * idempotency. Omitted by adapters that don't surface one.
+     */
+    eventId?: string;
+    /** Stable per-turn id (managed/Intelligence path). */
+    turnId?: string;
+    /** Lease/delivery id (managed/Intelligence path). */
+    deliveryId?: string;
+}
+export interface ThreadMessage {
+    user?: PlatformUser;
+    text: string;
+    ts?: string;
+    isBot?: boolean;
+}
+export interface Thread {
+    readonly platform: string;
+    post(ui: Renderable): Promise<MessageRef>;
+    update(ref: MessageRef, ui: Renderable): Promise<MessageRef>;
+    delete(ref: MessageRef): Promise<void>;
+    /**
+     * Post a picker and block until an interaction resolves it to the clicked
+     * button's `value`. Pass the expected value type, e.g.
+     * `awaitChoice<{ confirmed: boolean }>(<Picker/>)`.
+     */
+    awaitChoice<T = unknown>(ui: Renderable): Promise<T>;
+    runAgent(input?: unknown): Promise<MessageRef | undefined>;
+    resume(value: unknown): Promise<MessageRef | undefined>;
+    stream(src: string | AsyncIterable<string>): Promise<MessageRef>;
+    postFile(args: {
+        bytes: Uint8Array;
+        filename: string;
+        title?: string;
+        altText?: string;
+    }): Promise<{
+        ok: boolean;
+        fileId?: string;
+        error?: string;
+    }>;
+    /** Read the conversation's messages (capability-gated; returns `[]` when the adapter can't read history). */
+    getMessages(): Promise<ThreadMessage[]>;
+    /** Resolve a platform user by a free-form query (capability-gated; returns `undefined` when unsupported). */
+    lookupUser(query: string): Promise<PlatformUser | undefined>;
+    /** Pin suggested prompts (capability-gated; returns `{ ok: false }` on surfaces without support). */
+    setSuggestedPrompts(prompts: ReadonlyArray<{
+        title: string;
+        message: string;
+    }>, opts?: {
+        title?: string;
+    }): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    /** Name this conversation (capability-gated; returns `{ ok: false }` on surfaces without support). */
+    setTitle(title: string): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    /** Add an emoji reaction to a message (capability-gated; `{ ok: false }` on surfaces without support). */
+    react(messageRef: MessageRef, emoji: EmojiValue): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    /** Remove the bot's emoji reaction from a message (capability-gated). */
+    unreact(messageRef: MessageRef, emoji: EmojiValue): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    /**
+     * Post a message only `user` can see. `fallbackToDM` is required:
+     * `true` → DM the user when native ephemeral is unsupported; `false` →
+     * resolve to `null` when native ephemeral is unsupported.
+     */
+    postEphemeral(user: PlatformUser | string, ui: Renderable, opts: {
+        fallbackToDM: boolean;
+    }): Promise<EphemeralResult | null>;
+    /** Record this conversation as subscribed (persisted in state). Proactive delivery to subscribed conversations is not yet wired. */
+    subscribe(): Promise<void>;
+    /** Remove the subscription for this conversation. */
+    unsubscribe(): Promise<void>;
+    /** Returns true if this conversation is currently subscribed. */
+    isSubscribed(): Promise<boolean>;
+    /** Persist arbitrary per-thread state (e.g. workflow step). */
+    setState<T>(v: T): Promise<void>;
+    /** Read back per-thread state previously written with `setState`. */
+    state<T>(): Promise<T | undefined>;
+}
+export interface InteractionContext<TValue = unknown> {
+    thread: Thread;
+    message: IncomingMessage;
+    /** The clicked control: its opaque `id` and the `value` it carried (typed as `TValue`). */
+    action: {
+        id: string;
+        value?: TValue;
+    };
+    values: Record<string, unknown>;
+    user: PlatformUser;
+    platform: string;
+    /**
+     * Open a modal in response to this interaction (capability-gated; requires a
+     * platform trigger). Resolves `{ ok: false }` on surfaces without modal
+     * support or when the trigger has expired. On Discord, call this **before**
+     * any long-running work — the platform trigger expires ~3s after the click.
+     */
+    openModal?(view: ModalView): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+}
+export type ClickHandler<TValue = unknown> = (ctx: InteractionContext<TValue>) => void | Promise<void>;
+/** The reaction passed to a `<Message onReaction>` handler. */
+export interface MessageReaction {
+    /** Normalized emoji name when recognized, else the raw platform token. */
+    emoji: EmojiValue;
+    /** Platform-native emoji token. */
+    rawEmoji: string;
+    /** `true` = added, `false` = removed. */
+    added: boolean;
+    /** The reacting user, when the platform reports one. */
+    user?: PlatformUser;
+    /** Id of the reacted-to message. */
+    messageId: string;
+    /**
+     * The conversation thread — same surface an `onClick` gets via `ctx.thread`.
+     * Post new UI (`thread.post`), run the agent (`thread.runAgent`), block on a
+     * human choice (`thread.awaitChoice`, HITL), react back, etc.
+     */
+    thread: Thread;
+    /**
+     * Ref to the reacted-to message, for swapping its UI in place:
+     * `thread.update(reaction.messageRef, <NewUi/>)`.
+     */
+    messageRef: MessageRef;
+}
+/**
+ * Handler for reactions on a posted message, set via `<Message onReaction>`.
+ * Fires for both adds and removes (check `reaction.added`); the first arg is
+ * the emoji for the common `(reaction) => reaction === "bug"` shape. The second
+ * carries the full reaction including `thread`/`messageRef`, so a handler can
+ * post, swap UI, or run a HITL flow exactly like an `onClick`.
+ */
+export type MessageReactionHandler = (emoji: EmojiValue, reaction: MessageReaction) => void | Promise<void>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,sHAAsH;AACtH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,OAAO,CAAC;IACZ,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,+DAA+D;AAC/D,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhF;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,CAAC;AAElD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,UAAU,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7D,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC;;;;OAIG;IACH,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAC3D,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IACxD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,QAAQ,CAAC,IAAI,EAAE;QACb,KAAK,EAAE,UAAU,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9D,6GAA6G;IAC7G,WAAW,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IACxC,6GAA6G;IAC7G,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAC7D,qGAAqG;IACrG,mBAAmB,CACjB,OAAO,EAAE,aAAa,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,EAC1D,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GACxB,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5C,sGAAsG;IACtG,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAClE,0GAA0G;IAC1G,KAAK,CACH,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5C,yEAAyE;IACzE,OAAO,CACL,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5C;;;;OAIG;IACH,aAAa,CACX,IAAI,EAAE,YAAY,GAAG,MAAM,EAC3B,EAAE,EAAE,UAAU,EACd,IAAI,EAAE;QAAE,YAAY,EAAE,OAAO,CAAA;KAAE,GAC9B,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC;IACnC,oIAAoI;IACpI,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,qDAAqD;IACrD,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,iEAAiE;IACjE,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACjC,+DAA+D;IAC/D,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,qEAAqE;IACrE,KAAK,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CACpC;AACD,MAAM,WAAW,kBAAkB,CAAC,MAAM,GAAG,OAAO;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,eAAe,CAAC;IACzB,2FAA2F;IAC3F,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACvE;AACD,MAAM,MAAM,YAAY,CAAC,MAAM,GAAG,OAAO,IAAI,CAC3C,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,KAC5B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B,+DAA+D;AAC/D,MAAM,WAAW,eAAe;IAC9B,0EAA0E;IAC1E,KAAK,EAAE,UAAU,CAAC;IAClB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,KAAK,EAAE,OAAO,CAAC;IACf,wDAAwD;IACxD,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB;AACD;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG,CACnC,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,eAAe,KACtB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@copilotkit/channels-ui",
+  "version": "0.1.0",
+  "description": "JSX runtime, IR, and cross-platform component vocabulary for CopilotKit channels.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CopilotKit/CopilotKit.git"
+  },
+  "homepage": "https://github.com/CopilotKit/CopilotKit",
+  "keywords": [
+    "ai",
+    "agent",
+    "bot",
+    "jsx",
+    "block-kit",
+    "ui",
+    "copilotkit",
+    "ag-ui"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./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-dev-runtime.d.ts",
+      "import": "./dist/jsx-dev-runtime.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@copilotkit/shared": "^1.62.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^5.6.3",
+    "vitest": "^4.1.3",
+    "@copilotkit/typescript-config": "^1.55.0-next.8"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check-types": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.check.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "publint": "publint .",
+    "attw": "attw --pack . --profile esm-only"
+  }
+}