@skyramp/mcp 0.2.6 → 0.2.8-rc.1

package/build/types/TestAnalysis.d.ts

@@ -0,0 +1,97 @@
+import { TestExecutionResult } from "./TestExecution.js";
+export declare enum RecommendationPriority {
+    High = "high",
+    Medium = "medium",
+    Low = "low"
+}
+export declare enum IssueSeverity {
+    Low = "low",
+    Medium = "medium",
+    High = "high",
+    Critical = "critical"
+}
+export declare enum DriftChangeType {
+    EndpointAdded = "endpoint_added",
+    EndpointRemoved = "endpoint_removed",
+    EndpointRenamed = "endpoint_renamed",
+    EndpointModified = "endpoint_modified",
+    AuthenticationChanged = "authentication_changed",
+    SchemaChanges = "schema_changes",
+    RouteChanged = "route_changed",
+    RouteAdded = "route_added",
+    RouteRemoved = "route_removed",
+    UiComponentAdded = "ui_component_added",
+    UiComponentRemoved = "ui_component_removed",
+    UiComponentModified = "ui_component_modified",
+    UiComponentRestructured = "ui_component_restructured",
+    DependencyChanged = "dependency_changed",
+    FunctionChanged = "function_changed",
+    ClassChanged = "class_changed",
+    BreakingChange = "breaking_change",
+    CodeChange = "code_change"
+}
+export interface DriftChange {
+    type: DriftChangeType;
+    file: string;
+    description: string;
+    severity: IssueSeverity;
+    details?: string;
+}
+export interface AffectedFiles {
+    files: string[];
+}
+/** Origin of a test file — whether it was generated by Skyramp or is user/third-party maintained. */
+export declare enum TestSource {
+    Skyramp = "skyramp",
+    External = "external"
+}
+/** Drift action assigned by the LLM health assessment for an existing test. */
+export declare enum DriftAction {
+    Update = "UPDATE",
+    Regenerate = "REGENERATE",
+    Delete = "DELETE",
+    Verify = "VERIFY",
+    Ignore = "IGNORE"
+}
+/** Estimated effort to apply a drift UPDATE action. */
+export declare enum EstimatedWork {
+    Small = "Small",
+    Medium = "Medium",
+    Large = "Large"
+}
+/** Normalized internal recommendation built from LLM-supplied args.recommendations. */
+export interface DriftRecommendation {
+    testFile: string;
+    action: DriftAction;
+    priority: RecommendationPriority;
+    rationale: string;
+    estimatedWork: EstimatedWork;
+    updateInstructions: string;
+    renamedEndpoints: Array<{
+        oldPath: string;
+        newPath: string;
+        method: string;
+    }>;
+    /** Computed during instruction building — suggested renamed file path if applicable. */
+    _suggestedNewFile?: string;
+}
+/**
+ * Complete test analysis result that combines discovery, drift, execution, and health data
+ */
+export interface TestAnalysisResult {
+    testFile: string;
+    testType: string;
+    language: string;
+    framework: string;
+    apiSchema?: string;
+    apiEndpoint?: string;
+    /** Origin of this test. Defaults to TestSource.Skyramp for backwards compatibility
+     *  with existing state files. */
+    source?: TestSource;
+    drift?: {
+        changes: DriftChange[];
+        affectedFiles: AffectedFiles;
+    };
+    executionBefore?: TestExecutionResult;
+    executionAfter?: TestExecutionResult;
+}

package/build/types/TestExecution.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Types for Test Execution
+ *
+ * These types define the structure for test execution results
+ */
+/** Execution outcome for a test run recorded in the maintenance report. */
+export declare enum TestExecutionStatus {
+    Pass = "Pass",
+    Fail = "Fail",
+    Error = "Error",
+    /** Deliberately not executed — VERIFY/IGNORE actions or DELETE (file removed). */
+    Skipped = "Skipped",
+    /** Execution was expected (UPDATE/REGENERATE) but no result was recorded. */
+    Unknown = "Unknown"
+}
+export interface TestExecutionData {
+    status: TestExecutionStatus;
+    executedAt: string;
+    duration: number;
+    errors: string[];
+    warnings: string[];
+    output?: string;
+    exitCode?: number;
+}
+export interface TestExecutionResult extends TestExecutionData {
+    testFile: string;
+    videoPath?: string;
+}
+export interface BatchExecutionResult {
+    totalTests: number;
+    passed: number;
+    failed: number;
+    crashed: number;
+    totalDuration: number;
+    results: TestExecutionResult[];
+}
+export interface TestExecutionOptions {
+    testFile: string;
+    workspacePath: string;
+    language: string;
+    testType: string;
+    token?: string;
+    timeout?: number;
+    playwrightSaveStoragePath?: string;
+    useHostNetwork?: boolean;
+}
+/**
+ * Progress callback for reporting execution status
+ */
+export interface ExecutionProgress {
+    phase: "docker-check" | "docker-pull" | "preparing" | "executing" | "processing";
+    message: string;
+    percent: number;
+    details?: {
+        cached?: boolean;
+        pullProgress?: {
+            current?: number;
+            total?: number;
+            layer?: string;
+        };
+    };
+}
+export type ProgressCallback = (progress: ExecutionProgress) => Promise<void>;

package/build/types/TestExecution.js

@@ -3,4 +3,14 @@
  *
  * These types define the structure for test execution results
  */
-export {};
+/** Execution outcome for a test run recorded in the maintenance report. */
+export var TestExecutionStatus;
+(function (TestExecutionStatus) {
+    TestExecutionStatus["Pass"] = "Pass";
+    TestExecutionStatus["Fail"] = "Fail";
+    TestExecutionStatus["Error"] = "Error";
+    /** Deliberately not executed — VERIFY/IGNORE actions or DELETE (file removed). */
+    TestExecutionStatus["Skipped"] = "Skipped";
+    /** Execution was expected (UPDATE/REGENERATE) but no result was recorded. */
+    TestExecutionStatus["Unknown"] = "Unknown";
+})(TestExecutionStatus || (TestExecutionStatus = {}));

package/build/types/TestRecommendation.d.ts

@@ -0,0 +1,12 @@
+/** Internal scenario-scoring tier — UPPERCASE, includes CRITICAL. */
+export type PriorityTier = "CRITICAL" | "HIGH" | "MEDIUM" | "LOW";
+/** All categories including internal ones. */
+export declare const SCENARIO_CATEGORIES: readonly ["new_endpoint", "bug_caught", "business_rule", "security_boundary", "data_integrity", "breaking_change", "auth", "error_handling", "workflow", "data_validation", "crud"];
+export type ScenarioCategory = typeof SCENARIO_CATEGORIES[number];
+/** Categories valid for tool submissions (excludes internal-only categories). */
+export declare const TEST_CATEGORIES: readonly ["business_rule", "security_boundary", "data_integrity", "breaking_change", "auth", "error_handling", "workflow", "data_validation", "crud"];
+export type TestCategory = typeof TEST_CATEGORIES[number];
+/** Priority assignment for each category. */
+export declare const CATEGORY_PRIORITY: Record<ScenarioCategory, PriorityTier>;
+/** Map internal-only categories to their external equivalent for tool submission. */
+export declare function externalCategory(cat: ScenarioCategory): TestCategory;

package/build/types/TestTypes.d.ts

@@ -0,0 +1,234 @@
+import { z } from "zod";
+export declare const SESSION_STORAGE_FILENAME = "skyramp_session_storage.json";
+export declare const AUTH_PLACEHOLDER_TOKEN = "SKYRAMP_PLACEHOLDER_TOKEN";
+export declare enum ProgrammingLanguage {
+    PYTHON = "python",
+    TYPESCRIPT = "typescript",
+    JAVASCRIPT = "javascript",
+    JAVA = "java"
+}
+export declare enum TestType {
+    SMOKE = "smoke",
+    FUZZ = "fuzz",
+    CONTRACT = "contract",
+    LOAD = "load",
+    INTEGRATION = "integration",
+    E2E = "e2e",
+    UI = "ui",
+    MOCK = "mock"
+}
+export declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    HEAD = "HEAD",
+    OPTIONS = "OPTIONS"
+}
+export declare enum RuntimeEnvironment {
+    LOCAL = "local",
+    DOCKER = "docker",
+    KUBERNETES = "kubernetes"
+}
+export interface TestConfig {
+    testType: TestType;
+    toolName: string;
+    description: string;
+    additionalFields?: Record<string, z.ZodSchema>;
+}
+export declare const languageSchema: z.ZodObject<{
+    language: z.ZodNativeEnum<typeof ProgrammingLanguage>;
+    framework: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    language: ProgrammingLanguage;
+    framework: string;
+}, {
+    language: ProgrammingLanguage;
+    framework: string;
+}>;
+export declare const baseSchema: z.ZodObject<{
+    deployDashboard: z.ZodDefault<z.ZodBoolean>;
+    runtime: z.ZodDefault<z.ZodNativeEnum<typeof RuntimeEnvironment>>;
+    dockerNetwork: z.ZodDefault<z.ZodString>;
+    dockerWorkerPort: z.ZodDefault<z.ZodNumber>;
+    k8sNamespace: z.ZodDefault<z.ZodString>;
+    k8sConfig: z.ZodDefault<z.ZodString>;
+    k8sContext: z.ZodDefault<z.ZodString>;
+    authHeader: z.ZodDefault<z.ZodString>;
+    authScheme: z.ZodDefault<z.ZodString>;
+    insecure: z.ZodDefault<z.ZodBoolean>;
+    output: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
+    outputDir: z.ZodString;
+    force: z.ZodDefault<z.ZodBoolean>;
+    mockPort: z.ZodDefault<z.ZodNumber>;
+    optionalFields: z.ZodDefault<z.ZodBoolean>;
+    prompt: z.ZodString;
+    language: z.ZodNativeEnum<typeof ProgrammingLanguage>;
+    framework: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    language: ProgrammingLanguage;
+    framework: string;
+    deployDashboard: boolean;
+    runtime: RuntimeEnvironment;
+    dockerNetwork: string;
+    dockerWorkerPort: number;
+    k8sNamespace: string;
+    k8sConfig: string;
+    k8sContext: string;
+    authHeader: string;
+    authScheme: string;
+    insecure: boolean;
+    outputDir: string;
+    force: boolean;
+    mockPort: number;
+    optionalFields: boolean;
+    prompt: string;
+    output?: string | undefined;
+}, {
+    language: ProgrammingLanguage;
+    framework: string;
+    outputDir: string;
+    prompt: string;
+    deployDashboard?: boolean | undefined;
+    runtime?: RuntimeEnvironment | undefined;
+    dockerNetwork?: string | undefined;
+    dockerWorkerPort?: number | undefined;
+    k8sNamespace?: string | undefined;
+    k8sConfig?: string | undefined;
+    k8sContext?: string | undefined;
+    authHeader?: string | undefined;
+    authScheme?: string | undefined;
+    insecure?: boolean | undefined;
+    output?: string | undefined;
+    force?: boolean | undefined;
+    mockPort?: number | undefined;
+    optionalFields?: boolean | undefined;
+}>;
+export declare const basePlaywrightSchema: z.ZodObject<{
+    playwrightInput: z.ZodString;
+    playwrightStoragePath: z.ZodOptional<z.ZodString>;
+    playwrightSaveStoragePath: z.ZodOptional<z.ZodString>;
+    playwrightViewportSize: z.ZodDefault<z.ZodUnion<[z.ZodEnum<["", "hd", "full-hd", "2k"]>, z.ZodString]>>;
+    browser: z.ZodDefault<z.ZodEnum<["chromium", "firefox", "webkit"]>>;
+    device: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    playwrightInput: string;
+    playwrightViewportSize: string;
+    browser: "chromium" | "firefox" | "webkit";
+    device: string;
+    playwrightStoragePath?: string | undefined;
+    playwrightSaveStoragePath?: string | undefined;
+}, {
+    playwrightInput: string;
+    playwrightStoragePath?: string | undefined;
+    playwrightSaveStoragePath?: string | undefined;
+    playwrightViewportSize?: string | undefined;
+    browser?: "chromium" | "firefox" | "webkit" | undefined;
+    device?: string | undefined;
+}>;
+export declare const baseTraceSchema: z.ZodObject<{
+    deployDashboard: z.ZodDefault<z.ZodBoolean>;
+    runtime: z.ZodDefault<z.ZodNativeEnum<typeof RuntimeEnvironment>>;
+    dockerNetwork: z.ZodDefault<z.ZodString>;
+    dockerWorkerPort: z.ZodDefault<z.ZodNumber>;
+    k8sNamespace: z.ZodDefault<z.ZodString>;
+    k8sConfig: z.ZodDefault<z.ZodString>;
+    k8sContext: z.ZodDefault<z.ZodString>;
+    authHeader: z.ZodDefault<z.ZodString>;
+    authScheme: z.ZodDefault<z.ZodString>;
+    insecure: z.ZodDefault<z.ZodBoolean>;
+    output: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
+    outputDir: z.ZodString;
+    force: z.ZodDefault<z.ZodBoolean>;
+    mockPort: z.ZodDefault<z.ZodNumber>;
+    optionalFields: z.ZodDefault<z.ZodBoolean>;
+    prompt: z.ZodString;
+    language: z.ZodNativeEnum<typeof ProgrammingLanguage>;
+    framework: z.ZodString;
+    trace: z.ZodString;
+    include: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    exclude: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    language: ProgrammingLanguage;
+    framework: string;
+    deployDashboard: boolean;
+    runtime: RuntimeEnvironment;
+    dockerNetwork: string;
+    dockerWorkerPort: number;
+    k8sNamespace: string;
+    k8sConfig: string;
+    k8sContext: string;
+    authHeader: string;
+    authScheme: string;
+    insecure: boolean;
+    outputDir: string;
+    force: boolean;
+    mockPort: number;
+    optionalFields: boolean;
+    prompt: string;
+    trace: string;
+    include: string[];
+    exclude: string[];
+    output?: string | undefined;
+}, {
+    language: ProgrammingLanguage;
+    framework: string;
+    outputDir: string;
+    prompt: string;
+    trace: string;
+    deployDashboard?: boolean | undefined;
+    runtime?: RuntimeEnvironment | undefined;
+    dockerNetwork?: string | undefined;
+    dockerWorkerPort?: number | undefined;
+    k8sNamespace?: string | undefined;
+    k8sConfig?: string | undefined;
+    k8sContext?: string | undefined;
+    authHeader?: string | undefined;
+    authScheme?: string | undefined;
+    insecure?: boolean | undefined;
+    output?: string | undefined;
+    force?: boolean | undefined;
+    mockPort?: number | undefined;
+    optionalFields?: boolean | undefined;
+    include?: string[] | undefined;
+    exclude?: string[] | undefined;
+}>;
+export declare const baseTestSchema: {
+    deployDashboard: z.ZodDefault<z.ZodBoolean>;
+    runtime: z.ZodDefault<z.ZodNativeEnum<typeof RuntimeEnvironment>>;
+    dockerNetwork: z.ZodDefault<z.ZodString>;
+    dockerWorkerPort: z.ZodDefault<z.ZodNumber>;
+    k8sNamespace: z.ZodDefault<z.ZodString>;
+    k8sConfig: z.ZodDefault<z.ZodString>;
+    k8sContext: z.ZodDefault<z.ZodString>;
+    authHeader: z.ZodDefault<z.ZodString>;
+    authScheme: z.ZodDefault<z.ZodString>;
+    insecure: z.ZodDefault<z.ZodBoolean>;
+    output: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
+    outputDir: z.ZodString;
+    force: z.ZodDefault<z.ZodBoolean>;
+    mockPort: z.ZodDefault<z.ZodNumber>;
+    optionalFields: z.ZodDefault<z.ZodBoolean>;
+    prompt: z.ZodString;
+    language: z.ZodNativeEnum<typeof ProgrammingLanguage>;
+    framework: z.ZodString;
+    endpointURL: z.ZodString;
+    method: z.ZodDefault<z.ZodUnion<[z.ZodNativeEnum<typeof HttpMethod>, z.ZodLiteral<"">]>>;
+    apiSchema: z.ZodDefault<z.ZodString>;
+    pathParams: z.ZodDefault<z.ZodString>;
+    queryParams: z.ZodDefault<z.ZodString>;
+    formParams: z.ZodDefault<z.ZodString>;
+    requestData: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
+    responseStatusCode: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
+};
+export declare const codeRefactoringSchema: z.ZodObject<{
+    codeReuse: z.ZodDefault<z.ZodBoolean>;
+    modularizeCode: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    codeReuse: boolean;
+    modularizeCode: boolean;
+}, {
+    codeReuse?: boolean | undefined;
+    modularizeCode?: boolean | undefined;
+}>;

package/build/types/TestbotReport.d.ts

@@ -0,0 +1,68 @@
+import type { DriftAction } from "./TestAnalysis.js";
+import type { TestExecutionStatus } from "./TestExecution.js";
+import type { HttpMethod, TestType } from "./TestTypes.js";
+/**
+ * Shape of the JSON report written by skyramp_submit_report and read by testbot
+ * for rendering as Markdown. All fields mirror the corresponding Zod schemas in
+ * submitReportTool.ts — keep the two in sync.
+ */
+export interface TestbotReport {
+    businessCaseAnalysis: string;
+    newTestsCreated: {
+        testId: string;
+        testType: TestType;
+        endpoint: string;
+        fileName: string;
+        reasoning: string;
+        description?: string;
+        scenarioFile?: string;
+        traceFile?: string;
+        frontendTrace?: string;
+    }[];
+    /** Omitted when no existing tests were found (agent omits the field). */
+    testMaintenance?: {
+        testType: TestType;
+        endpoint: string;
+        fileName: string;
+        description: string;
+        action: DriftAction;
+        beforeStatus: TestExecutionStatus;
+        beforeDetails: string;
+        afterStatus: TestExecutionStatus;
+        afterDetails: string;
+    }[];
+    testResults: {
+        testType: TestType;
+        endpoint: string;
+        status: "Pass" | "Fail" | "Skipped";
+        details: string;
+        videoPath?: string;
+    }[];
+    additionalRecommendations?: {
+        testId: string;
+        testType: TestType;
+        category?: string;
+        primaryEndpoint?: string;
+        scenarioName?: string;
+        steps: {
+            method?: HttpMethod;
+            path?: string;
+            description: string;
+            expectedStatusCode?: number;
+            requestBody?: Record<string, unknown>;
+            responseBody?: Record<string, unknown>;
+        }[];
+        description: string;
+        priority: "high" | "medium" | "low";
+        reasoning: string;
+        openApiSpec?: string;
+        backendTrace?: string;
+        frontendTrace?: string;
+    }[];
+    issuesFound: {
+        description: string;
+        severity?: "critical" | "high" | "medium" | "low";
+    }[];
+    nextSteps: string[];
+    commitMessage: string;
+}

package/build/types/TestbotReport.js

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

package/build/types/index.d.ts

@@ -0,0 +1,4 @@
+export { TestExecutionStatus } from "./TestExecution.js";
+export { DriftAction } from "./TestAnalysis.js";
+export { TestType, HttpMethod } from "./TestTypes.js";
+export type { TestbotReport } from "./TestbotReport.js";

package/build/types/index.js

@@ -0,0 +1,3 @@
+export { TestExecutionStatus } from "./TestExecution.js";
+export { DriftAction } from "./TestAnalysis.js";
+export { TestType, HttpMethod } from "./TestTypes.js";