cucumberstudio-mcp 1.1.0

package/README.md

@@ -0,0 +1,395 @@
+# Cucumber Studio MCP Server
+
+[![NPM Version](https://img.shields.io/npm/v/cucumberstudio-mcp)](https://www.npmjs.com/package/cucumberstudio-mcp)
+[![NPM Downloads](https://img.shields.io/npm/dm/cucumberstudio-mcp)](https://www.npmjs.com/package/cucumberstudio-mcp)
+[![Docker Pulls](https://img.shields.io/docker/pulls/herosizy/cucumberstudio-mcp)](https://hub.docker.com/r/herosizy/cucumberstudio-mcp)
+[![GitHub Release](https://img.shields.io/github/v/release/HeroSizy/cucumberstudio-mcp)](https://github.com/HeroSizy/cucumberstudio-mcp/releases)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/HeroSizy/cucumberstudio-mcp/release.yml)](https://github.com/HeroSizy/cucumberstudio-mcp/actions)
+[![Test Coverage](https://img.shields.io/badge/coverage-82%25-brightgreen)](https://github.com/HeroSizy/cucumberstudio-mcp)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/github/license/HeroSizy/cucumberstudio-mcp)](https://github.com/HeroSizy/cucumberstudio-mcp/blob/master/LICENSE)
+
+A Model Context Protocol (MCP) server that provides LLM access to Cucumber Studio's testing platform. This server enables AI assistants to retrieve test scenarios, action words, test runs, and project information from Cucumber Studio.
+
+## Features
+
+- **Dual Transport Support** - STDIO and Streamable HTTP transports with session management
+- **Project Management** - List and retrieve project details
+- **Scenario Access** - Browse test scenarios and search by tags
+- **Action Words** - Access reusable test steps and definitions
+- **Test Execution** - View test runs, executions, and build information
+- **Hot Reload Development** - Instant server restart on file changes with tsx --watch
+- **Configurable Logging** - Structured logging with multiple output destinations
+- **Comprehensive Error Handling** - Robust error handling with detailed feedback
+- **Type Safety** - Full TypeScript implementation with Zod validation
+- **Comprehensive Testing** - 82%+ test coverage with Vitest and MSW
+
+## Installation
+
+### Quick Start (Recommended)
+
+Run directly with npx (no installation required):
+```bash
+npx cucumberstudio-mcp
+```
+
+Set your environment variables first:
+```bash
+export CUCUMBERSTUDIO_ACCESS_TOKEN="your_token"
+export CUCUMBERSTUDIO_CLIENT_ID="your_client_id"
+export CUCUMBERSTUDIO_UID="your_uid"
+```
+
+### Development Installation
+
+1. Clone the repository:
+```bash
+git clone https://github.com/HeroSizy/cucumberstudio-mcp.git
+cd cucumberstudio-mcp
+```
+
+2. Install dependencies:
+```bash
+npm install
+```
+
+3. Set up environment variables:
+```bash
+cp .env.example .env
+# Edit .env with your Cucumber Studio API credentials
+```
+
+4. Build the server:
+```bash
+npm run build
+```
+
+## Docker Support
+
+### Using Pre-built Image (Recommended)
+
+Run the official Docker image from Docker Hub:
+```bash
+# With environment file
+docker run --env-file .env herosizy/cucumberstudio-mcp
+
+# With environment variables
+docker run -e CUCUMBERSTUDIO_ACCESS_TOKEN=your_token \
+           -e CUCUMBERSTUDIO_CLIENT_ID=your_client_id \
+           -e CUCUMBERSTUDIO_UID=your_uid \
+           herosizy/cucumberstudio-mcp
+```
+
+### Using Docker Compose
+
+1. Set up environment variables:
+```bash
+cp .env.example .env
+# Edit .env with your Cucumber Studio API credentials
+```
+
+2. Update docker-compose.yml to use the pre-built image:
+```yaml
+version: '3.8'
+services:
+  cucumberstudio-mcp:
+    image: herosizy/cucumberstudio-mcp
+    env_file:
+      - .env
+    restart: unless-stopped
+    ports:
+      - "${MCP_PORT:-3000}:3000"
+```
+
+3. Run with Docker Compose:
+```bash
+docker-compose up
+```
+
+### Building Locally
+
+1. Build the image:
+```bash
+npm run docker:build
+```
+
+2. Run the container:
+```bash
+npm run docker:run
+```
+
+The Docker setup includes health checks and automatic restarts for production use.
+
+## Configuration
+
+The server requires Cucumber Studio API credentials. Get these from your Cucumber Studio account settings:
+
+### Required Environment Variables
+- `CUCUMBERSTUDIO_ACCESS_TOKEN` - Your API access token
+- `CUCUMBERSTUDIO_CLIENT_ID` - Your client ID  
+- `CUCUMBERSTUDIO_UID` - Your user ID
+
+### Optional Configuration
+- `CUCUMBERSTUDIO_BASE_URL` - API base URL (default: https://studio.cucumberstudio.com/api)
+- `MCP_TRANSPORT` - Transport type: `stdio` (default), `http`, or `streamable-http`
+- `MCP_PORT` - HTTP transport port (default: 3000)
+- `MCP_HOST` - HTTP transport host (default: 0.0.0.0)
+- `MCP_CORS_ORIGIN` - CORS origin setting (default: true)
+
+### Logging Configuration
+- `LOG_LEVEL` - Log level: `error`, `warn`, `info`, `debug`, `trace` (default: info)
+- `LOG_API_RESPONSES` - Log Cucumber Studio API responses (default: false)
+- `LOG_REQUEST_BODIES` - Log API request bodies for debugging (default: false)
+- `LOG_RESPONSE_BODIES` - Log API response bodies for debugging (default: false)
+- `LOG_TRANSPORT` - Logging output: `console`, `stderr`, `file`, `none` (default: stderr)
+- `LOG_FILE` - Log file path (required if LOG_TRANSPORT=file)
+
+## Usage
+
+### Transport Options
+
+The server supports both STDIO and HTTP transports:
+
+#### STDIO Transport (Default)
+```bash
+# Development
+npm run dev
+
+# Production
+npm start
+```
+
+#### HTTP Transport
+```bash
+# Development
+npm run dev:http
+
+# Production
+npm run start:http
+```
+
+
+### Using with Claude Desktop
+
+#### Option 1: NPX (Recommended)
+```json
+{
+  "mcpServers": {
+    "cucumberstudio": {
+      "command": "npx",
+      "args": ["cucumberstudio-mcp"],
+      "env": {
+        "CUCUMBERSTUDIO_ACCESS_TOKEN": "your_token",
+        "CUCUMBERSTUDIO_CLIENT_ID": "your_client_id",
+        "CUCUMBERSTUDIO_UID": "your_uid"
+      }
+    }
+  }
+}
+```
+
+#### Option 2: Local Installation
+```json
+{
+  "mcpServers": {
+    "cucumberstudio": {
+      "command": "node",
+      "args": ["/path/to/cucumberstudio-mcp/build/index.js"],
+      "env": {
+        "CUCUMBERSTUDIO_ACCESS_TOKEN": "your_token",
+        "CUCUMBERSTUDIO_CLIENT_ID": "your_client_id",
+        "CUCUMBERSTUDIO_UID": "your_uid"
+      }
+    }
+  }
+}
+```
+
+#### Option 3: Docker Hub Image
+```json
+{
+  "mcpServers": {
+    "cucumberstudio": {
+      "command": "docker",
+      "args": ["run", "--rm", "-i", "--env-file", "/path/to/.env", "herosizy/cucumberstudio-mcp"]
+    }
+  }
+}
+```
+
+#### Option 4: Local Docker Build
+```json
+{
+  "mcpServers": {
+    "cucumberstudio": {
+      "command": "docker",
+      "args": ["run", "--rm", "-i", "--env-file", "/path/to/.env", "cucumberstudio-mcp"]
+    }
+  }
+}
+```
+
+## Available Tools
+
+### Project Tools
+- `cucumberstudio_list_projects` - List all accessible projects
+- `cucumberstudio_get_project` - Get detailed project information
+
+### Scenario Tools
+- `cucumberstudio_list_scenarios` - List scenarios in a project
+- `cucumberstudio_get_scenario` - Get detailed scenario information
+- `cucumberstudio_find_scenarios_by_tags` - Find scenarios by tags
+
+### Action Word Tools
+- `cucumberstudio_list_action_words` - List reusable action words
+- `cucumberstudio_get_action_word` - Get detailed action word information
+- `cucumberstudio_find_action_words_by_tags` - Find action words by tags
+
+### Test Execution Tools
+- `cucumberstudio_list_test_runs` - List test runs
+- `cucumberstudio_get_test_run` - Get detailed test run information
+- `cucumberstudio_get_test_executions` - Get individual test results
+- `cucumberstudio_list_builds` - List builds
+- `cucumberstudio_get_build` - Get build details
+- `cucumberstudio_list_execution_environments` - List execution environments
+
+## Development
+
+### Hot Reload Development
+The server supports hot reload for rapid development:
+
+```bash
+# STDIO transport with hot reload
+npm run dev
+
+# HTTP transport with hot reload  
+npm run dev:http
+```
+
+Files are automatically recompiled and the server restarts when changes are detected.
+
+### Testing and Quality
+```bash
+# Install dependencies
+npm install
+
+# Run type checking
+npm run typecheck
+
+# Run linting
+npm run lint
+
+# Build for production
+npm run build
+
+# Run tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run tests with coverage (82%+ coverage)
+npm run test:coverage
+
+# Run tests with UI
+npm run test:ui
+```
+
+## Architecture
+
+The server is built with a modular, production-ready architecture:
+
+### Core Technologies
+- **TypeScript** - Full type safety with strict configuration
+- **Dual Transports** - STDIO for local use, Streamable HTTP for remote access
+- **Zod** - Runtime validation for API inputs and configuration
+- **Axios** - HTTP client with comprehensive error handling and logging
+- **MCP SDK** - Official Model Context Protocol implementation
+- **Express** - HTTP server with CORS, security middleware, and session management
+- **Vitest** - Modern testing framework with 82%+ code coverage
+- **MSW** - Mock Service Worker for realistic API testing
+
+### Key Features
+- **Session Management** - HTTP transport with session tracking and cleanup
+- **Comprehensive Logging** - Structured logging with configurable outputs and levels
+- **Error Handling** - Robust error handling with detailed feedback and recovery
+- **Security** - Origin validation, CORS protection, and input sanitization
+- **Health Monitoring** - Health check endpoints and request/response tracking
+- **Development Workflow** - Hot reload, comprehensive testing, and Docker support
+
+## Testing
+
+The project includes comprehensive test coverage:
+
+```bash
+# Run all tests
+npm test
+
+# Run tests with coverage report
+npm run test:coverage
+
+# Run tests in watch mode (for development)
+npm run test:watch
+```
+
+Test coverage includes:
+- Unit tests for all modules
+- Integration tests for the MCP server
+- Transport layer testing
+- API client mocking and testing
+- Configuration validation
+- Error handling scenarios
+
+## Publishing and Releases
+
+This project uses automated releases via GitHub Actions. When a version tag is pushed, it automatically:
+
+1. **Runs full test suite** - Ensures code quality and coverage
+2. **Publishes to NPM** - Makes the package available via `npx cucumberstudio-mcp`
+3. **Builds and publishes Docker image** - Pushes multi-platform images to Docker Hub
+4. **Creates GitHub release** - Generates release notes and links
+
+### Creating a Release
+
+1. Update the version in `package.json`:
+```bash
+npm version patch|minor|major
+```
+
+2. Push the tag to trigger the release:
+```bash
+git push origin --tags
+```
+
+3. The GitHub Action will automatically:
+   - Publish to NPM: https://www.npmjs.com/package/cucumberstudio-mcp
+   - Push to Docker Hub: https://hub.docker.com/r/herosizy/cucumberstudio-mcp
+   - Create a GitHub release with changelog
+
+### Required Secrets
+
+For automated publishing, the following secrets must be configured in the GitHub repository:
+
+- `NPM_TOKEN` - NPM authentication token
+- `DOCKER_USERNAME` - Docker Hub username  
+- `DOCKER_PASSWORD` - Docker Hub password or access token
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests for new functionality
+5. Ensure all tests pass: `npm test`
+6. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Resources
+
+- [Cucumber Studio API Documentation](https://studio-api.cucumberstudio.com/#introduction)
+- [Cucumber Studio API Reference](https://github.com/SmartBear/cucumberstudio-api-documentation)
+- [Model Context Protocol](https://modelcontextprotocol.io/)
+- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)

package/build/api/client.d.ts

@@ -0,0 +1,49 @@
+import { Config } from '../config/settings.js';
+import { Logger } from '../utils/logger.js';
+import { CucumberStudioResponse, CucumberStudioError, ListParams, Project, Scenario, ActionWord, Folder, TestRun, TestExecution, Build, ExecutionEnvironment } from './types.js';
+export declare class CucumberStudioApiError extends Error {
+    status?: number | undefined;
+    details?: CucumberStudioError | undefined;
+    constructor(message: string, status?: number | undefined, details?: CucumberStudioError | undefined);
+}
+export declare class CucumberStudioApiClient {
+    private config;
+    private logger;
+    private client;
+    constructor(config: Config, logger: Logger);
+    /**
+     * Get logging configuration with safe defaults
+     */
+    private getLoggingConfig;
+    /**
+     * Sanitize headers to avoid logging sensitive information
+     */
+    private sanitizeHeaders;
+    /**
+     * Generic GET request handler
+     */
+    private get;
+    getProjects(params?: ListParams): Promise<CucumberStudioResponse<Project[]>>;
+    getProject(projectId: string): Promise<CucumberStudioResponse<Project>>;
+    getScenarios(projectId: string, params?: ListParams): Promise<CucumberStudioResponse<Scenario[]>>;
+    getScenario(projectId: string, scenarioId: string): Promise<CucumberStudioResponse<Scenario>>;
+    findScenariosByTag(projectId: string, tags: string, params?: ListParams): Promise<CucumberStudioResponse<Scenario[]>>;
+    getActionWords(projectId: string, params?: ListParams): Promise<CucumberStudioResponse<ActionWord[]>>;
+    getActionWord(projectId: string, actionWordId: string): Promise<CucumberStudioResponse<ActionWord>>;
+    findActionWordsByTag(projectId: string, tags: string, params?: ListParams): Promise<CucumberStudioResponse<ActionWord[]>>;
+    getFolders(projectId: string, params?: ListParams): Promise<CucumberStudioResponse<Folder[]>>;
+    getFolder(projectId: string, folderId: string): Promise<CucumberStudioResponse<Folder>>;
+    getFolderChildren(projectId: string, folderId: string, params?: ListParams): Promise<CucumberStudioResponse<Folder[]>>;
+    getFolderScenarios(projectId: string, folderId: string, params?: ListParams): Promise<CucumberStudioResponse<Scenario[]>>;
+    getTestRuns(projectId: string, params?: ListParams): Promise<CucumberStudioResponse<TestRun[]>>;
+    getTestRun(projectId: string, testRunId: string): Promise<CucumberStudioResponse<TestRun>>;
+    getTestExecutions(projectId: string, testRunId: string, params?: ListParams): Promise<CucumberStudioResponse<TestExecution[]>>;
+    getBuilds(projectId: string, params?: ListParams): Promise<CucumberStudioResponse<Build[]>>;
+    getBuild(projectId: string, buildId: string): Promise<CucumberStudioResponse<Build>>;
+    getExecutionEnvironments(projectId: string, params?: ListParams): Promise<CucumberStudioResponse<ExecutionEnvironment[]>>;
+    /**
+     * Test the connection to Cucumber Studio API
+     */
+    testConnection(): Promise<boolean>;
+}
+//# sourceMappingURL=client.d.ts.map

package/build/api/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAE9C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAE3C,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,MAAM,EACN,OAAO,EACP,aAAa,EACb,KAAK,EACL,oBAAoB,EACrB,MAAM,YAAY,CAAA;AAEnB,qBAAa,sBAAuB,SAAQ,KAAK;IAGtC,MAAM,CAAC,EAAE,MAAM;IACf,OAAO,CAAC,EAAE,mBAAmB;gBAFpC,OAAO,EAAE,MAAM,EACR,MAAM,CAAC,EAAE,MAAM,YAAA,EACf,OAAO,CAAC,EAAE,mBAAmB,YAAA;CAKvC;AAED,qBAAa,uBAAuB;IAIhC,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,MAAM;IAJhB,OAAO,CAAC,MAAM,CAAe;gBAGnB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM;IA0FxB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAWxB;;OAEG;IACH,OAAO,CAAC,eAAe;IAevB;;OAEG;YACW,GAAG;IAMX,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC,CAAC;IAI5E,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAKvE,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,CAAC;IAIjG,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAI7F,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,CAAC;IAQxC,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,UAAU,EAAE,CAAC,CAAC;IAIrG,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAInG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,UAAU,EAAE,CAAC,CAAC;IAQ1C,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC,CAAC;IAI7F,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAIvF,iBAAiB,CACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC,CAAC;IAItC,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,CAAC;IAKxC,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC,CAAC;IAI/F,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAI1F,iBAAiB,CACrB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,aAAa,EAAE,CAAC,CAAC;IAK7C,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC,CAAC;IAI3F,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAKpF,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAI1D;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;CAQzC"}

package/build/api/client.js

@@ -0,0 +1,204 @@
+import axios from 'axios';
+import { API_VERSION_HEADER, API_TIMEOUT, REDACTED_STRING } from '../constants.js';
+export class CucumberStudioApiError extends Error {
+    status;
+    details;
+    constructor(message, status, details) {
+        super(message);
+        this.status = status;
+        this.details = details;
+        this.name = 'CucumberStudioApiError';
+    }
+}
+export class CucumberStudioApiClient {
+    config;
+    logger;
+    client;
+    constructor(config, logger) {
+        this.config = config;
+        this.logger = logger;
+        this.client = axios.create({
+            baseURL: config.cucumberStudio.baseUrl,
+            headers: {
+                Accept: API_VERSION_HEADER,
+                'Content-Type': 'application/json',
+                'access-token': config.cucumberStudio.accessToken,
+                client: config.cucumberStudio.clientId,
+                uid: config.cucumberStudio.uid,
+            },
+            timeout: API_TIMEOUT,
+        });
+        // Add request interceptor for logging
+        this.client.interceptors.request.use((config) => {
+            this.logger.debug(`🚀 Request: ${config.method?.toUpperCase()} ${config.url}`, {
+                headers: this.sanitizeHeaders(config.headers),
+                params: config.params,
+                bodySize: config.data ? JSON.stringify(config.data).length : 0,
+            });
+            if (this.getLoggingConfig().logRequestBodies && config.data) {
+                this.logger.trace('📤 Request Body:', config.data);
+            }
+            return config;
+        }, (error) => {
+            this.logger.error('❌ Request Error:', error);
+            return Promise.reject(error);
+        });
+        // Add response interceptor for logging and error handling
+        this.client.interceptors.response.use((response) => {
+            this.logger.debug(`✅ Response: ${response.status} ${response.config.method?.toUpperCase()} ${response.config.url}`, {
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers,
+                dataSize: response.data ? JSON.stringify(response.data).length : 0,
+            });
+            if (this.getLoggingConfig().logApiResponses || this.getLoggingConfig().logResponseBodies) {
+                this.logger.debug('📥 Cucumber Studio Response:', {
+                    status: response.status,
+                    url: response.config.url,
+                    data: response.data,
+                });
+            }
+            return response;
+        }, (error) => {
+            if (error.response) {
+                const status = error.response.status;
+                const data = error.response.data;
+                this.logger.error(`❌ API Error: ${status} ${error.config?.method?.toUpperCase()} ${error.config?.url}`, {
+                    status,
+                    statusText: error.response.statusText,
+                    data,
+                    headers: error.response.headers,
+                });
+                let message = `API request failed with status ${status}`;
+                if (data?.errors?.length > 0) {
+                    message = data.errors.map((e) => e.detail).join('; ');
+                }
+                throw new CucumberStudioApiError(message, status, data);
+            }
+            else if (error.request) {
+                this.logger.error('🔌 No Response:', {
+                    url: error.config?.url,
+                    timeout: error.code === 'ECONNABORTED',
+                });
+                throw new CucumberStudioApiError('No response received from Cucumber Studio API');
+            }
+            else {
+                this.logger.error('⚙️ Request Setup Error:', error.message);
+                throw new CucumberStudioApiError(`Request setup failed: ${error.message}`);
+            }
+        });
+    }
+    /**
+     * Get logging configuration with safe defaults
+     */
+    getLoggingConfig() {
+        return (this.config.logging || {
+            level: 'info',
+            logApiResponses: false,
+            logRequestBodies: false,
+            logResponseBodies: false,
+        });
+    }
+    /**
+     * Sanitize headers to avoid logging sensitive information
+     */
+    sanitizeHeaders(headers) {
+        if (!headers)
+            return headers;
+        const sanitized = { ...headers };
+        const sensitiveKeys = ['access-token', 'authorization', 'cookie', 'x-api-key'];
+        for (const key of sensitiveKeys) {
+            if (key in sanitized) {
+                sanitized[key] = REDACTED_STRING;
+            }
+        }
+        return sanitized;
+    }
+    /**
+     * Generic GET request handler
+     */
+    async get(endpoint, params) {
+        const response = await this.client.get(endpoint, { params });
+        return response.data;
+    }
+    // PROJECT ENDPOINTS
+    async getProjects(params) {
+        return this.get('/projects', params);
+    }
+    async getProject(projectId) {
+        return this.get(`/projects/${projectId}`);
+    }
+    // SCENARIO ENDPOINTS
+    async getScenarios(projectId, params) {
+        return this.get(`/projects/${projectId}/scenarios`, params);
+    }
+    async getScenario(projectId, scenarioId) {
+        return this.get(`/projects/${projectId}/scenarios/${scenarioId}`);
+    }
+    async findScenariosByTag(projectId, tags, params) {
+        return this.get(`/projects/${projectId}/scenarios/find_by_tags`, {
+            ...params,
+            'filter[tags]': tags,
+        });
+    }
+    // ACTION WORD ENDPOINTS
+    async getActionWords(projectId, params) {
+        return this.get(`/projects/${projectId}/actionwords`, params);
+    }
+    async getActionWord(projectId, actionWordId) {
+        return this.get(`/projects/${projectId}/actionwords/${actionWordId}`);
+    }
+    async findActionWordsByTag(projectId, tags, params) {
+        return this.get(`/projects/${projectId}/actionwords/find_by_tags`, {
+            ...params,
+            'filter[tags]': tags,
+        });
+    }
+    // FOLDER ENDPOINTS
+    async getFolders(projectId, params) {
+        return this.get(`/projects/${projectId}/folders`, params);
+    }
+    async getFolder(projectId, folderId) {
+        return this.get(`/projects/${projectId}/folders/${folderId}`);
+    }
+    async getFolderChildren(projectId, folderId, params) {
+        return this.get(`/projects/${projectId}/folders/${folderId}/children`, params);
+    }
+    async getFolderScenarios(projectId, folderId, params) {
+        return this.get(`/projects/${projectId}/folders/${folderId}/scenarios`, params);
+    }
+    // TEST RUN ENDPOINTS
+    async getTestRuns(projectId, params) {
+        return this.get(`/projects/${projectId}/test_runs`, params);
+    }
+    async getTestRun(projectId, testRunId) {
+        return this.get(`/projects/${projectId}/test_runs/${testRunId}`);
+    }
+    async getTestExecutions(projectId, testRunId, params) {
+        return this.get(`/projects/${projectId}/test_runs/${testRunId}/test_executions`, params);
+    }
+    // BUILD ENDPOINTS
+    async getBuilds(projectId, params) {
+        return this.get(`/projects/${projectId}/builds`, params);
+    }
+    async getBuild(projectId, buildId) {
+        return this.get(`/projects/${projectId}/builds/${buildId}`);
+    }
+    // EXECUTION ENVIRONMENT ENDPOINTS
+    async getExecutionEnvironments(projectId, params) {
+        return this.get(`/projects/${projectId}/execution_environments`, params);
+    }
+    /**
+     * Test the connection to Cucumber Studio API
+     */
+    async testConnection() {
+        try {
+            await this.getProjects({ 'page[size]': 1 });
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+}
+//# sourceMappingURL=client.js.map

package/build/api/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAuC,MAAM,OAAO,CAAA;AAG3D,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAiBlF,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAGtC;IACA;IAHT,YACE,OAAe,EACR,MAAe,EACf,OAA6B;QAEpC,KAAK,CAAC,OAAO,CAAC,CAAA;QAHP,WAAM,GAAN,MAAM,CAAS;QACf,YAAO,GAAP,OAAO,CAAsB;QAGpC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAA;IACtC,CAAC;CACF;AAED,MAAM,OAAO,uBAAuB;IAIxB;IACA;IAJF,MAAM,CAAe;IAE7B,YACU,MAAc,EACd,MAAc;QADd,WAAM,GAAN,MAAM,CAAQ;QACd,WAAM,GAAN,MAAM,CAAQ;QAEtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,MAAM,CAAC,cAAc,CAAC,OAAO;YACtC,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;gBAClC,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,WAAW;gBACjD,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,QAAQ;gBACtC,GAAG,EAAE,MAAM,CAAC,cAAc,CAAC,GAAG;aAC/B;YACD,OAAO,EAAE,WAAW;SACrB,CAAC,CAAA;QAEF,sCAAsC;QACtC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAClC,CAAC,MAAM,EAAE,EAAE;YACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,MAAM,CAAC,GAAG,EAAE,EAAE;gBAC7E,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC7C,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aAC/D,CAAC,CAAA;YAEF,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC,gBAAgB,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;YACpD,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAA;YAC5C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC9B,CAAC,CACF,CAAA;QAED,0DAA0D;QAC1D,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CACnC,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,eAAe,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,EAChG;gBACE,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aACnE,CACF,CAAA;YAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC,eAAe,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC,iBAAiB,EAAE,CAAC;gBACzF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE;oBAChD,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG;oBACxB,IAAI,EAAE,QAAQ,CAAC,IAAI;iBACpB,CAAC,CAAA;YACJ,CAAC;YAED,OAAO,QAAQ,CAAA;QACjB,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACnB,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAA;gBACpC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,IAA2B,CAAA;gBAEvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;oBACtG,MAAM;oBACN,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,UAAU;oBACrC,IAAI;oBACJ,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO;iBAChC,CAAC,CAAA;gBAEF,IAAI,OAAO,GAAG,kCAAkC,MAAM,EAAE,CAAA;gBACxD,IAAI,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC7B,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACvD,CAAC;gBAED,MAAM,IAAI,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;YACzD,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE;oBACnC,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG;oBACtB,OAAO,EAAE,KAAK,CAAC,IAAI,KAAK,cAAc;iBACvC,CAAC,CAAA;gBACF,MAAM,IAAI,sBAAsB,CAAC,+CAA+C,CAAC,CAAA;YACnF,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;gBAC3D,MAAM,IAAI,sBAAsB,CAAC,yBAAyB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;YAC5E,CAAC;QACH,CAAC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,OAAO,CACL,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI;YACrB,KAAK,EAAE,MAAe;YACtB,eAAe,EAAE,KAAK;YACtB,gBAAgB,EAAE,KAAK;YACvB,iBAAiB,EAAE,KAAK;SACzB,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,OAAgC;QACtD,IAAI,CAAC,OAAO;YAAE,OAAO,OAAO,CAAA;QAE5B,MAAM,SAAS,GAAG,EAAE,GAAG,OAAO,EAAE,CAAA;QAChC,MAAM,aAAa,GAAG,CAAC,cAAc,EAAE,eAAe,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAA;QAE9E,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;YAChC,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;gBACrB,SAAS,CAAC,GAAG,CAAC,GAAG,eAAe,CAAA;YAClC,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,GAAG,CAAI,QAAgB,EAAE,MAAgC;QACrE,MAAM,QAAQ,GAA6C,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;QACtG,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,oBAAoB;IACpB,KAAK,CAAC,WAAW,CAAC,MAAmB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAY,WAAW,EAAE,MAAM,CAAC,CAAA;IACjD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,SAAiB;QAChC,OAAO,IAAI,CAAC,GAAG,CAAU,aAAa,SAAS,EAAE,CAAC,CAAA;IACpD,CAAC;IAED,qBAAqB;IACrB,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,MAAmB;QACvD,OAAO,IAAI,CAAC,GAAG,CAAa,aAAa,SAAS,YAAY,EAAE,MAAM,CAAC,CAAA;IACzE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,UAAkB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAW,aAAa,SAAS,cAAc,UAAU,EAAE,CAAC,CAAA;IAC7E,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,SAAiB,EACjB,IAAY,EACZ,MAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAa,aAAa,SAAS,yBAAyB,EAAE;YAC3E,GAAG,MAAM;YACT,cAAc,EAAE,IAAI;SACrB,CAAC,CAAA;IACJ,CAAC;IAED,wBAAwB;IACxB,KAAK,CAAC,cAAc,CAAC,SAAiB,EAAE,MAAmB;QACzD,OAAO,IAAI,CAAC,GAAG,CAAe,aAAa,SAAS,cAAc,EAAE,MAAM,CAAC,CAAA;IAC7E,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,YAAoB;QACzD,OAAO,IAAI,CAAC,GAAG,CAAa,aAAa,SAAS,gBAAgB,YAAY,EAAE,CAAC,CAAA;IACnF,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,SAAiB,EACjB,IAAY,EACZ,MAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAe,aAAa,SAAS,2BAA2B,EAAE;YAC/E,GAAG,MAAM;YACT,cAAc,EAAE,IAAI;SACrB,CAAC,CAAA;IACJ,CAAC;IAED,mBAAmB;IACnB,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,MAAmB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAW,aAAa,SAAS,UAAU,EAAE,MAAM,CAAC,CAAA;IACrE,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,SAAiB,EAAE,QAAgB;QACjD,OAAO,IAAI,CAAC,GAAG,CAAS,aAAa,SAAS,YAAY,QAAQ,EAAE,CAAC,CAAA;IACvE,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,SAAiB,EACjB,QAAgB,EAChB,MAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAW,aAAa,SAAS,YAAY,QAAQ,WAAW,EAAE,MAAM,CAAC,CAAA;IAC1F,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,SAAiB,EACjB,QAAgB,EAChB,MAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAa,aAAa,SAAS,YAAY,QAAQ,YAAY,EAAE,MAAM,CAAC,CAAA;IAC7F,CAAC;IAED,qBAAqB;IACrB,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,MAAmB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAY,aAAa,SAAS,YAAY,EAAE,MAAM,CAAC,CAAA;IACxE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,SAAiB;QACnD,OAAO,IAAI,CAAC,GAAG,CAAU,aAAa,SAAS,cAAc,SAAS,EAAE,CAAC,CAAA;IAC3E,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,SAAiB,EACjB,SAAiB,EACjB,MAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAkB,aAAa,SAAS,cAAc,SAAS,kBAAkB,EAAE,MAAM,CAAC,CAAA;IAC3G,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,SAAS,CAAC,SAAiB,EAAE,MAAmB;QACpD,OAAO,IAAI,CAAC,GAAG,CAAU,aAAa,SAAS,SAAS,EAAE,MAAM,CAAC,CAAA;IACnE,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,OAAe;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAQ,aAAa,SAAS,WAAW,OAAO,EAAE,CAAC,CAAA;IACpE,CAAC;IAED,kCAAkC;IAClC,KAAK,CAAC,wBAAwB,CAC5B,SAAiB,EACjB,MAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAyB,aAAa,SAAS,yBAAyB,EAAE,MAAM,CAAC,CAAA;IAClG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,CAAA;YAC3C,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;CACF"}