@frontmcp/testing 0.6.1 → 0.6.2

package/src/client/mcp-test-client.builder.js

@@ -1,163 +0,0 @@
-"use strict";
-/**
- * @file mcp-test-client.builder.ts
- * @description Builder pattern for creating McpTestClient instances
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.McpTestClientBuilder = void 0;
-const mcp_test_client_1 = require("./mcp-test-client");
-const platform_client_info_1 = require("../platform/platform-client-info");
-/**
- * Builder for creating McpTestClient instances with fluent API
- *
- * @example
- * ```typescript
- * const client = await McpTestClient.create({ baseUrl: 'http://localhost:3003' })
- *   .withTransport('streamable-http')
- *   .withToken('my-jwt-token')
- *   .withTimeout(5000)
- *   .withDebug()
- *   .buildAndConnect();
- * ```
- */
-class McpTestClientBuilder {
-    config;
-    constructor(config) {
-        this.config = { ...config };
-    }
-    /**
-     * Set the authentication configuration
-     */
-    withAuth(auth) {
-        this.config.auth = { ...this.config.auth, ...auth };
-        return this;
-    }
-    /**
-     * Set the bearer token for authentication
-     */
-    withToken(token) {
-        this.config.auth = { ...this.config.auth, token };
-        return this;
-    }
-    /**
-     * Add custom headers to all requests
-     */
-    withHeaders(headers) {
-        this.config.auth = {
-            ...this.config.auth,
-            headers: { ...this.config.auth?.headers, ...headers },
-        };
-        return this;
-    }
-    /**
-     * Set the transport type
-     */
-    withTransport(transport) {
-        this.config.transport = transport;
-        return this;
-    }
-    /**
-     * Set the request timeout in milliseconds
-     */
-    withTimeout(timeoutMs) {
-        this.config.timeout = timeoutMs;
-        return this;
-    }
-    /**
-     * Enable debug logging
-     */
-    withDebug(enabled = true) {
-        this.config.debug = enabled;
-        return this;
-    }
-    /**
-     * Enable public mode - skip authentication entirely.
-     * When true, no Authorization header is sent and anonymous token is not requested.
-     * Use this for testing public/unauthenticated endpoints in CI/CD pipelines.
-     */
-    withPublicMode(enabled = true) {
-        this.config.publicMode = enabled;
-        return this;
-    }
-    /**
-     * Set the MCP protocol version to request
-     */
-    withProtocolVersion(version) {
-        this.config.protocolVersion = version;
-        return this;
-    }
-    /**
-     * Set the client info sent during initialization
-     */
-    withClientInfo(info) {
-        this.config.clientInfo = info;
-        return this;
-    }
-    /**
-     * Set the platform type for testing platform-specific meta keys.
-     * Automatically configures clientInfo and capabilities for platform detection.
-     *
-     * Platform-specific behavior:
-     * - `openai`: Uses openai/* meta keys, sets User-Agent to "ChatGPT/1.0"
-     * - `ext-apps`: Uses ui/* meta keys per SEP-1865, sets io.modelcontextprotocol/ui capability
-     * - `claude`: Uses frontmcp/* + ui/* keys, sets User-Agent to "claude-desktop/1.0"
-     * - `cursor`: Uses frontmcp/* + ui/* keys, sets User-Agent to "cursor/1.0"
-     * - Other platforms follow similar patterns
-     *
-     * @example
-     * ```typescript
-     * const client = await McpTestClient.create({ baseUrl })
-     *   .withPlatform('openai')
-     *   .buildAndConnect();
-     *
-     * // ext-apps automatically sets the io.modelcontextprotocol/ui capability
-     * const extAppsClient = await McpTestClient.create({ baseUrl })
-     *   .withPlatform('ext-apps')
-     *   .buildAndConnect();
-     * ```
-     */
-    withPlatform(platform) {
-        this.config.platform = platform;
-        // Auto-set clientInfo based on platform for User-Agent detection
-        this.config.clientInfo = (0, platform_client_info_1.getPlatformClientInfo)(platform);
-        // Auto-set capabilities based on platform (ext-apps requires io.modelcontextprotocol/ui)
-        this.config.capabilities = (0, platform_client_info_1.getPlatformCapabilities)(platform);
-        return this;
-    }
-    /**
-     * Set custom client capabilities for MCP initialization.
-     * Use this for fine-grained control over capabilities sent during initialization.
-     *
-     * @example
-     * ```typescript
-     * const client = await McpTestClient.create({ baseUrl })
-     *   .withCapabilities({
-     *     sampling: {},
-     *     experimental: {
-     *       'io.modelcontextprotocol/ui': { mimeTypes: ['text/html+mcp'] }
-     *     }
-     *   })
-     *   .buildAndConnect();
-     * ```
-     */
-    withCapabilities(capabilities) {
-        this.config.capabilities = capabilities;
-        return this;
-    }
-    /**
-     * Build the McpTestClient instance (does not connect)
-     */
-    build() {
-        return new mcp_test_client_1.McpTestClient(this.config);
-    }
-    /**
-     * Build the McpTestClient and connect to the server
-     */
-    async buildAndConnect() {
-        const client = this.build();
-        await client.connect();
-        return client;
-    }
-}
-exports.McpTestClientBuilder = McpTestClientBuilder;
-//# sourceMappingURL=mcp-test-client.builder.js.map

package/src/client/mcp-test-client.builder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mcp-test-client.builder.js","sourceRoot":"","sources":["../../../src/client/mcp-test-client.builder.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,uDAAkD;AAElD,2EAAkG;AAElG;;;;;;;;;;;;GAYG;AACH,MAAa,oBAAoB;IACvB,MAAM,CAAsB;IAEpC,YAAY,MAA2B;QACrC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,IAAoB;QAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,OAA+B;QACzC,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG;YACjB,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI;YACnB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;SACtD,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,SAA4B;QACxC,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,SAAiB;QAC3B,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAO,GAAG,IAAI;QACtB,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,OAAO,GAAG,IAAI;QAC3B,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,OAAO,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,IAAuC;QACpD,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAY,CAAC,QAA0B;QACrC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChC,iEAAiE;QACjE,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,IAAA,4CAAqB,EAAC,QAAQ,CAAC,CAAC;QACzD,yFAAyF;QACzF,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,IAAA,8CAAuB,EAAC,QAAQ,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,YAAoC;QACnD,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,+BAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAxJD,oDAwJC","sourcesContent":["/**\n * @file mcp-test-client.builder.ts\n * @description Builder pattern for creating McpTestClient instances\n */\n\nimport type {\n  McpTestClientConfig,\n  TestTransportType,\n  TestAuthConfig,\n  TestClientCapabilities,\n} from './mcp-test-client.types';\nimport { McpTestClient } from './mcp-test-client';\nimport type { TestPlatformType } from '../platform/platform-types';\nimport { getPlatformClientInfo, getPlatformCapabilities } from '../platform/platform-client-info';\n\n/**\n * Builder for creating McpTestClient instances with fluent API\n *\n * @example\n * ```typescript\n * const client = await McpTestClient.create({ baseUrl: 'http://localhost:3003' })\n *   .withTransport('streamable-http')\n *   .withToken('my-jwt-token')\n *   .withTimeout(5000)\n *   .withDebug()\n *   .buildAndConnect();\n * ```\n */\nexport class McpTestClientBuilder {\n  private config: McpTestClientConfig;\n\n  constructor(config: McpTestClientConfig) {\n    this.config = { ...config };\n  }\n\n  /**\n   * Set the authentication configuration\n   */\n  withAuth(auth: TestAuthConfig): this {\n    this.config.auth = { ...this.config.auth, ...auth };\n    return this;\n  }\n\n  /**\n   * Set the bearer token for authentication\n   */\n  withToken(token: string): this {\n    this.config.auth = { ...this.config.auth, token };\n    return this;\n  }\n\n  /**\n   * Add custom headers to all requests\n   */\n  withHeaders(headers: Record<string, string>): this {\n    this.config.auth = {\n      ...this.config.auth,\n      headers: { ...this.config.auth?.headers, ...headers },\n    };\n    return this;\n  }\n\n  /**\n   * Set the transport type\n   */\n  withTransport(transport: TestTransportType): this {\n    this.config.transport = transport;\n    return this;\n  }\n\n  /**\n   * Set the request timeout in milliseconds\n   */\n  withTimeout(timeoutMs: number): this {\n    this.config.timeout = timeoutMs;\n    return this;\n  }\n\n  /**\n   * Enable debug logging\n   */\n  withDebug(enabled = true): this {\n    this.config.debug = enabled;\n    return this;\n  }\n\n  /**\n   * Enable public mode - skip authentication entirely.\n   * When true, no Authorization header is sent and anonymous token is not requested.\n   * Use this for testing public/unauthenticated endpoints in CI/CD pipelines.\n   */\n  withPublicMode(enabled = true): this {\n    this.config.publicMode = enabled;\n    return this;\n  }\n\n  /**\n   * Set the MCP protocol version to request\n   */\n  withProtocolVersion(version: string): this {\n    this.config.protocolVersion = version;\n    return this;\n  }\n\n  /**\n   * Set the client info sent during initialization\n   */\n  withClientInfo(info: { name: string; version: string }): this {\n    this.config.clientInfo = info;\n    return this;\n  }\n\n  /**\n   * Set the platform type for testing platform-specific meta keys.\n   * Automatically configures clientInfo and capabilities for platform detection.\n   *\n   * Platform-specific behavior:\n   * - `openai`: Uses openai/* meta keys, sets User-Agent to \"ChatGPT/1.0\"\n   * - `ext-apps`: Uses ui/* meta keys per SEP-1865, sets io.modelcontextprotocol/ui capability\n   * - `claude`: Uses frontmcp/* + ui/* keys, sets User-Agent to \"claude-desktop/1.0\"\n   * - `cursor`: Uses frontmcp/* + ui/* keys, sets User-Agent to \"cursor/1.0\"\n   * - Other platforms follow similar patterns\n   *\n   * @example\n   * ```typescript\n   * const client = await McpTestClient.create({ baseUrl })\n   *   .withPlatform('openai')\n   *   .buildAndConnect();\n   *\n   * // ext-apps automatically sets the io.modelcontextprotocol/ui capability\n   * const extAppsClient = await McpTestClient.create({ baseUrl })\n   *   .withPlatform('ext-apps')\n   *   .buildAndConnect();\n   * ```\n   */\n  withPlatform(platform: TestPlatformType): this {\n    this.config.platform = platform;\n    // Auto-set clientInfo based on platform for User-Agent detection\n    this.config.clientInfo = getPlatformClientInfo(platform);\n    // Auto-set capabilities based on platform (ext-apps requires io.modelcontextprotocol/ui)\n    this.config.capabilities = getPlatformCapabilities(platform);\n    return this;\n  }\n\n  /**\n   * Set custom client capabilities for MCP initialization.\n   * Use this for fine-grained control over capabilities sent during initialization.\n   *\n   * @example\n   * ```typescript\n   * const client = await McpTestClient.create({ baseUrl })\n   *   .withCapabilities({\n   *     sampling: {},\n   *     experimental: {\n   *       'io.modelcontextprotocol/ui': { mimeTypes: ['text/html+mcp'] }\n   *     }\n   *   })\n   *   .buildAndConnect();\n   * ```\n   */\n  withCapabilities(capabilities: TestClientCapabilities): this {\n    this.config.capabilities = capabilities;\n    return this;\n  }\n\n  /**\n   * Build the McpTestClient instance (does not connect)\n   */\n  build(): McpTestClient {\n    return new McpTestClient(this.config);\n  }\n\n  /**\n   * Build the McpTestClient and connect to the server\n   */\n  async buildAndConnect(): Promise<McpTestClient> {\n    const client = this.build();\n    await client.connect();\n    return client;\n  }\n}\n"]}