@microsoft/m365agentsplayground-cli 0.2.25-alpha.20260507-efe1416.0

package/build/types.d.ts

@@ -0,0 +1,125 @@
+import { AccountRole } from "schema";
+import { Message } from "server";
+import type { Attachment } from "server";
+export { ActionType, LogActionType } from "schema";
+export type { IAction, ICreateMessageAction, IUpdateMessageAction, ITypingAction, IActionMessage, ILogAction, IAppendLogAction, LogItem, } from "schema";
+/**
+ * Bot configuration matching the .m365agentsplayground.yml format
+ */
+export interface BotConfig {
+    /**
+     * Bot's unique identifier
+     */
+    id: string;
+    /**
+     * Bot display name (max 42 characters)
+     */
+    name: string;
+    /**
+     * User ID for agentic-role bots
+     */
+    agenticUserId?: string;
+    /**
+     * App ID for agentic-role bots
+     */
+    agenticAppId?: string;
+    /**
+     * Bot's tenant ID (defaults to root tenant)
+     */
+    tenantId?: string;
+    /**
+     * Bot role: "user" | "bot" | "agenticUser"
+     */
+    role?: AccountRole;
+}
+/**
+ * Configuration for the TestClient
+ */
+export interface TestClientConfig {
+    /**
+     * The bot endpoint URL (e.g., "http://localhost:3978/api/messages")
+     */
+    botEndpoint: string;
+    /**
+     * Timeout in milliseconds for waiting for bot responses.
+     * Default: 5000
+     */
+    timeout?: number;
+    /**
+     * Port to run the test server on.
+     * Default: auto-assigned
+     */
+    port?: number;
+    /**
+     * Bot configuration (id, name, role, etc.)
+     * If not provided, uses default bot config.
+     */
+    bot?: BotConfig;
+    /**
+     * Chat type to use when sending messages.
+     * - "personal": 1:1 personal chat with the bot (default)
+     * - "group": group chat context
+     * - "channel": team channel context
+     */
+    chatType?: "personal" | "group" | "channel";
+    /**
+     * Delivery mode for activities sent to the bot.
+     * - "expectReplies": Bot responses come inline in the HTTP response.
+     * - "default": Bot posts responses back to the connector URL.
+     */
+    deliveryMode?: "expectReplies" | "default";
+    /**
+     * Quiet-period fallback (ms) for streaming bot responses.
+     *
+     * When the simulator detects a streaming placeholder (`"Loading stream results..."`),
+     * it first waits for a `streamType:"final"` WebSocket event (the precise end-of-stream
+     * signal sent by teams-ai / teams.ts SDK). If no `streamType:"final"` arrives, it falls
+     * back to a quiet-period: resolves after this many milliseconds with no new
+     * `updateActivity` events.
+     *
+     * Default: 800 ms. Has no effect for bots with `stream: false`.
+     *
+     * @example
+     * // Increase for slow LLMs
+     * const client = new TestClient({
+     *   botEndpoint: "http://localhost:3978/api/messages",
+     *   streamingSettleDelayMs: 2000,
+     * });
+     */
+    streamingSettleDelayMs?: number;
+}
+/**
+ * A response from the bot
+ */
+export interface BotResponse {
+    /**
+     * The unique message ID
+     */
+    messageId: string;
+    /**
+     * The text content of the response
+     */
+    text?: string;
+    /**
+     * Attachments in the response (e.g., Adaptive Cards)
+     */
+    attachments?: Attachment[];
+    /**
+     * Timestamp when the message was created
+     */
+    timestamp: number;
+    /**
+     * The raw Message object from ConversationManager
+     */
+    raw: Message;
+}
+/**
+ * Promise handlers for async response waiting
+ */
+export interface PendingResponse {
+    resolve: (messages: Message[]) => void;
+    reject: (error: Error) => void;
+    timer: NodeJS.Timeout;
+    messageCountBefore: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAGzC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACnD,YAAY,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,aAAa,EACb,cAAc,EAEd,UAAU,EACV,gBAAgB,EAChB,OAAO,GACR,MAAM,QAAQ,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,GAAG,CAAC,EAAE,SAAS,CAAC;IAEhB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;IAE5C;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAE3C;;;;;;;;;;;;;;;;;OAiBG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACvC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}

package/build/types.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogActionType = exports.ActionType = void 0;
+// Re-export action types for consumers
+var schema_1 = require("schema");
+Object.defineProperty(exports, "ActionType", { enumerable: true, get: function () { return schema_1.ActionType; } });
+Object.defineProperty(exports, "LogActionType", { enumerable: true, get: function () { return schema_1.LogActionType; } });

package/build/websocketClient.d.ts

@@ -0,0 +1,56 @@
+import { IAction, ILogAction } from "schema";
+export interface WebSocketClientOptions {
+    port: number;
+    onMessage: (action: IAction) => void;
+    onError?: (error: Error) => void;
+    onClose?: () => void;
+}
+export interface LogWebSocketClientOptions {
+    port: number;
+    onLogMessage: (action: ILogAction) => void;
+    onError?: (error: Error) => void;
+    onClose?: () => void;
+}
+/**
+ * WebSocket client for connecting to the conversation WebSocket endpoint.
+ * Receives real-time message and typing events from the server.
+ */
+export declare class WebSocketClient {
+    private ws;
+    private options;
+    constructor(options: WebSocketClientOptions);
+    /**
+     * Connect to the WebSocket server
+     */
+    connect(): Promise<void>;
+    /**
+     * Close the WebSocket connection
+     */
+    close(): void;
+    /**
+     * Check if the WebSocket is connected
+     */
+    isConnected(): boolean;
+}
+/**
+ * WebSocket client for connecting to the log WebSocket endpoint.
+ * Receives real-time log events from the server.
+ */
+export declare class LogWebSocketClient {
+    private ws;
+    private options;
+    constructor(options: LogWebSocketClientOptions);
+    /**
+     * Connect to the log WebSocket server
+     */
+    connect(): Promise<void>;
+    /**
+     * Close the WebSocket connection
+     */
+    close(): void;
+    /**
+     * Check if the WebSocket is connected
+     */
+    isConnected(): boolean;
+}
+//# sourceMappingURL=websocketClient.d.ts.map

package/build/websocketClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocketClient.d.ts","sourceRoot":"","sources":["../src/websocketClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAK7C,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACrC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;IAC3C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,OAAO,CAAyB;gBAE5B,OAAO,EAAE,sBAAsB;IAI3C;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkCxB;;OAEG;IACH,KAAK,IAAI,IAAI;IAOb;;OAEG;IACH,WAAW,IAAI,OAAO;CAGvB;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,OAAO,CAA4B;gBAE/B,OAAO,EAAE,yBAAyB;IAI9C;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkCxB;;OAEG;IACH,KAAK,IAAI,IAAI;IAOb;;OAEG;IACH,WAAW,IAAI,OAAO;CAGvB"}

package/build/websocketClient.js

@@ -0,0 +1,129 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogWebSocketClient = exports.WebSocketClient = void 0;
+const ws_1 = __importDefault(require("ws"));
+const CONVERSATION_WS_PATH = "/_ws_conversation/v1/conversations/stream";
+const LOG_WS_PATH = "/_ws/log/stream";
+/**
+ * WebSocket client for connecting to the conversation WebSocket endpoint.
+ * Receives real-time message and typing events from the server.
+ */
+class WebSocketClient {
+    ws = null;
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    /**
+     * Connect to the WebSocket server
+     */
+    connect() {
+        return new Promise((resolve, reject) => {
+            const url = `ws://localhost:${this.options.port}${CONVERSATION_WS_PATH}`;
+            this.ws = new ws_1.default(url);
+            this.ws.on("open", () => {
+                // Small delay to ensure server has processed the connection
+                setTimeout(resolve, 50);
+            });
+            this.ws.on("message", (data) => {
+                try {
+                    const message = JSON.parse(data.toString());
+                    this.options.onMessage(message);
+                }
+                catch (err) {
+                    console.error("Failed to parse WebSocket message:", err);
+                }
+            });
+            this.ws.on("error", (err) => {
+                if (this.options.onError) {
+                    this.options.onError(err);
+                }
+                reject(err);
+            });
+            this.ws.on("close", () => {
+                if (this.options.onClose) {
+                    this.options.onClose();
+                }
+            });
+        });
+    }
+    /**
+     * Close the WebSocket connection
+     */
+    close() {
+        if (this.ws) {
+            this.ws.close();
+            this.ws = null;
+        }
+    }
+    /**
+     * Check if the WebSocket is connected
+     */
+    isConnected() {
+        return this.ws !== null && this.ws.readyState === ws_1.default.OPEN;
+    }
+}
+exports.WebSocketClient = WebSocketClient;
+/**
+ * WebSocket client for connecting to the log WebSocket endpoint.
+ * Receives real-time log events from the server.
+ */
+class LogWebSocketClient {
+    ws = null;
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    /**
+     * Connect to the log WebSocket server
+     */
+    connect() {
+        return new Promise((resolve, reject) => {
+            const url = `ws://localhost:${this.options.port}${LOG_WS_PATH}`;
+            this.ws = new ws_1.default(url);
+            this.ws.on("open", () => {
+                // Small delay to ensure server has processed the connection
+                setTimeout(resolve, 50);
+            });
+            this.ws.on("message", (data) => {
+                try {
+                    const message = JSON.parse(data.toString());
+                    this.options.onLogMessage(message);
+                }
+                catch (err) {
+                    console.error("Failed to parse log WebSocket message:", err);
+                }
+            });
+            this.ws.on("error", (err) => {
+                if (this.options.onError) {
+                    this.options.onError(err);
+                }
+                reject(err);
+            });
+            this.ws.on("close", () => {
+                if (this.options.onClose) {
+                    this.options.onClose();
+                }
+            });
+        });
+    }
+    /**
+     * Close the WebSocket connection
+     */
+    close() {
+        if (this.ws) {
+            this.ws.close();
+            this.ws = null;
+        }
+    }
+    /**
+     * Check if the WebSocket is connected
+     */
+    isConnected() {
+        return this.ws !== null && this.ws.readyState === ws_1.default.OPEN;
+    }
+}
+exports.LogWebSocketClient = LogWebSocketClient;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@microsoft/m365agentsplayground-cli",
+  "version": "0.2.25-alpha.20260507-efe1416.0",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "bin": {
+    "playground-cli-server": "build/start-server.js"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "server": "node build/start-server.js"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.5",
+    "@types/express": "5.0.1",
+    "@types/express-serve-static-core": "5.0.6",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.3.1",
+    "@types/ws": "^8.5.10",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "adaptivecards": "^3.0.4",
+    "express": "^5.2.0",
+    "schema": "^0.2.25-alpha.20260507-efe1416.0",
+    "server": "^0.2.25-alpha.20260507-efe1416.0",
+    "ws": "^8.18.0"
+  },
+  "bundledDependencies": [
+    "server",
+    "schema"
+  ]
+}

package/src/cardValidator.ts

@@ -0,0 +1,56 @@
+/**
+ * Adaptive Card schema validation using the official `adaptivecards` package.
+ *
+ * Validates that a card payload is a well-formed Adaptive Card that Teams can
+ * parse. Does NOT check visual rendering — only structural/schema correctness.
+ */
+
+import { AdaptiveCard, SerializationContext } from "adaptivecards";
+
+export interface CardValidationError {
+  /** Human-readable description of the issue */
+  message: string;
+  /** "parsing" | "schema" */
+  phase: string;
+}
+
+/**
+ * Validate a raw Adaptive Card JSON payload.
+ * Returns an empty array if the card is valid.
+ */
+export function validateAdaptiveCard(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  payload: Record<string, unknown>
+): CardValidationError[] {
+  const errors: CardValidationError[] = [];
+
+  // Basic type guard: must have type === "AdaptiveCard"
+  if (payload.type !== "AdaptiveCard") {
+    errors.push({
+      message: `Expected type "AdaptiveCard", got "${payload.type ?? "(missing)"}"`,
+      phase: "schema",
+    });
+    return errors; // No point parsing further
+  }
+
+  try {
+    const card = new AdaptiveCard();
+    const context = new SerializationContext();
+    card.parse(payload, context);
+
+    for (let i = 0; i < context.eventCount; i++) {
+      const event = context.getEventAt(i);
+      errors.push({
+        message: event.message ?? String(event),
+        phase: event.phase !== undefined ? String(event.phase) : "parsing",
+      });
+    }
+  } catch (err) {
+    errors.push({
+      message: err instanceof Error ? err.message : String(err),
+      phase: "parsing",
+    });
+  }
+
+  return errors;
+}

package/src/conversationServer.ts

@@ -0,0 +1,147 @@
+/**
+ * HTTP server for multi-turn conversation execution.
+ *
+ * Provides a factory function that creates an HTTP server with:
+ *   POST /run-conversation — execute a multi-turn conversation
+ *   GET  /health           — health check
+ *
+ * All diagnostic logging goes to stderr. The returned port can be
+ * written to stdout by the caller (CLI wrapper).
+ */
+
+import * as http from "http";
+import { runConversation, log, logError } from "./runConversation";
+import type { E2EConfig, ConversationInput } from "./conversationTypes";
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Public types
+// ─────────────────────────────────────────────────────────────────────────────
+
+export interface ConversationServerOptions {
+  /** Port to listen on. Default: 0 (OS-assigned). */
+  port?: number;
+  /** Host to bind to. Default: "127.0.0.1". */
+  host?: string;
+}
+
+export interface ConversationServer {
+  /** The port the server is listening on. */
+  port: number;
+  /** Gracefully shut down the server. */
+  close: () => Promise<void>;
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Request body parsing
+// ─────────────────────────────────────────────────────────────────────────────
+
+function readBody(req: http.IncomingMessage): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const chunks: Buffer[] = [];
+    req.on("data", (chunk: Buffer) => chunks.push(chunk));
+    req.on("end", () => resolve(Buffer.concat(chunks).toString("utf-8")));
+    req.on("error", reject);
+  });
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Request handler
+// ─────────────────────────────────────────────────────────────────────────────
+
+interface RunConversationRequest {
+  config: E2EConfig;
+  scenario: string;
+  input: ConversationInput;
+}
+
+async function handleRequest(req: http.IncomingMessage, res: http.ServerResponse): Promise<void> {
+  const url = req.url ?? "";
+  const method = req.method ?? "";
+
+  if (method === "GET" && url === "/health") {
+    res.writeHead(200, { "Content-Type": "application/json" });
+    res.end(JSON.stringify({ status: "ok" }));
+    return;
+  }
+
+  if (method === "POST" && url === "/run-conversation") {
+    let body: RunConversationRequest;
+    try {
+      const raw = await readBody(req);
+      body = JSON.parse(raw) as RunConversationRequest;
+    } catch (err) {
+      const message = err instanceof Error ? err.message : String(err);
+      res.writeHead(400, { "Content-Type": "application/json" });
+      res.end(JSON.stringify({ error: `Invalid JSON: ${message}` }));
+      return;
+    }
+
+    if (!body.config || !body.scenario || !body.input) {
+      res.writeHead(400, { "Content-Type": "application/json" });
+      res.end(JSON.stringify({ error: "Missing required fields: config, scenario, input" }));
+      return;
+    }
+
+    try {
+      log(`HTTP request: ${body.scenario}`);
+      const result = await runConversation(body.config, body.scenario, body.input);
+
+      res.writeHead(200, { "Content-Type": "application/json" });
+      res.end(JSON.stringify(result));
+    } catch (err) {
+      const message = err instanceof Error ? err.message : String(err);
+      logError(`Unhandled error in runConversation: ${message}`);
+      res.writeHead(500, { "Content-Type": "application/json" });
+      res.end(JSON.stringify({ error: message }));
+    }
+    return;
+  }
+
+  res.writeHead(404, { "Content-Type": "application/json" });
+  res.end(JSON.stringify({ error: "Not found" }));
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Factory
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Create and start a conversation server.
+ *
+ * Returns a handle with the assigned port and a close() method.
+ */
+export async function createConversationServer(
+  options?: ConversationServerOptions
+): Promise<ConversationServer> {
+  const port = options?.port ?? 0;
+  const host = options?.host ?? "127.0.0.1";
+
+  const server = http.createServer((req: http.IncomingMessage, res: http.ServerResponse) => {
+    handleRequest(req, res).catch((err) => {
+      logError(`Request handler crashed: ${String(err)}`);
+      if (!res.headersSent) {
+        res.writeHead(500, { "Content-Type": "application/json" });
+      }
+      res.end(JSON.stringify({ error: "Internal server error" }));
+    });
+  });
+
+  return new Promise<ConversationServer>((resolve, reject) => {
+    server.once("error", reject);
+
+    server.listen(port, host, () => {
+      const addr = server.address();
+      const assignedPort = typeof addr === "object" && addr ? addr.port : port;
+
+      log(`Server listening on http://${host}:${assignedPort}`);
+
+      resolve({
+        port: assignedPort,
+        close: () =>
+          new Promise<void>((res, rej) => {
+            server.close((err: Error | undefined) => (err ? rej(err) : res()));
+          }),
+      });
+    });
+  });
+}