@flink-app/api-docs-plugin 0.12.1-alpha.40 → 0.12.1-alpha.47

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@flink-app/api-docs-plugin",
-    "version": "0.12.1-alpha.40",
+    "version": "0.12.1-alpha.47",
     "description": "Flink plugin that generates API documentation based on JSON schemas",
     "scripts": {
         "test": "echo \"Error: no test specified\"",
-        "prepare": "npm run build:react && tsc && npm run copy:assets",
+        "build": "npm run build:react && tsc && npm run copy:assets",
         "build:react": "cd react-app && npm run build",
         "copy:assets": "mkdir -p dist/react-app && cp -r react-app/dist/* dist/react-app/",
         "watch": "tsc-watch",
@@ -21,7 +21,7 @@
     "types": "dist/index.d.ts",
     "main": "dist/index.js",
     "devDependencies": {
-        "@flink-app/flink": "^0.12.1-alpha.40",
+        "@flink-app/flink": "^0.12.1-alpha.47",
         "@types/express": "^4.17.12",
         "@types/node": "22.13.10",
         "express": "^4.18.2",
@@ -29,5 +29,5 @@
         "tsc-watch": "^4.2.9",
         "typescript": "5.4.5"
     },
-    "gitHead": "456502f273fe9473df05b71a803f3eda1a2f8931"
+    "gitHead": "a98a0af7f11e4a97f68da4d0d67677df7d2a2749"
 }

package/dist/mcp-server.d.ts

@@ -1,3 +0,0 @@
-import { FlinkApp } from "@flink-app/flink";
-import type { Request, Response } from "express";
-export declare function createMcpHandler(app: FlinkApp<any>): (req: Request, res: Response) => Promise<void>;

package/dist/mcp-server.js

@@ -1,250 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMcpHandler = void 0;
-// Helper function to simplify schema conversion
-function flattenProperties(properties, required, parent) {
-    if (required === void 0) { required = []; }
-    if (parent === void 0) { parent = ""; }
-    var result = [];
-    for (var _i = 0, _a = Object.entries(properties || {}); _i < _a.length; _i++) {
-        var _b = _a[_i], key = _b[0], value = _b[1];
-        var path = parent ? "".concat(parent, ".").concat(key) : key;
-        result.push({
-            name: path,
-            type: value.type,
-            description: value.description,
-            required: required.includes(key),
-        });
-        if (value.type === "object" && value.properties) {
-            result = result.concat(flattenProperties(value.properties, value.required || [], path));
-        }
-        if (value.type === "array" && value.items && value.items.type === "object" && value.items.properties) {
-            result = result.concat(flattenProperties(value.items.properties, value.items.required || [], "".concat(path, "[]")));
-        }
-    }
-    return result;
-}
-// For creating an Express endpoint that handles MCP requests
-function createMcpHandler(app) {
-    var _this = this;
-    return function (req, res) { return __awaiter(_this, void 0, void 0, function () {
-        var endpoints, _a, method, params, tools, _b, name_1, args, endpoint, response_1;
-        return __generator(this, function (_c) {
-            try {
-                endpoints = app.handlers.map(function (handler) {
-                    var _a, _b, _c, _d, _e, _f;
-                    return ({
-                        path: handler.routeProps.path,
-                        method: handler.routeProps.method.toUpperCase(),
-                        description: (_b = (_a = handler.schema) === null || _a === void 0 ? void 0 : _a.reqSchema) === null || _b === void 0 ? void 0 : _b.description,
-                        queryParams: handler.queryMetadata,
-                        pathParams: handler.paramsMetadata,
-                        requestBody: ((_d = (_c = handler.schema) === null || _c === void 0 ? void 0 : _c.reqSchema) === null || _d === void 0 ? void 0 : _d.properties)
-                            ? flattenProperties(handler.schema.reqSchema.properties, handler.schema.reqSchema.required || [])
-                            : undefined,
-                        responseBody: ((_f = (_e = handler.schema) === null || _e === void 0 ? void 0 : _e.resSchema) === null || _f === void 0 ? void 0 : _f.properties)
-                            ? flattenProperties(handler.schema.resSchema.properties, handler.schema.resSchema.required || [])
-                            : undefined,
-                    });
-                });
-                // For WebSocket upgrade requests
-                if (req.headers.upgrade === "websocket") {
-                    // Handle WebSocket upgrade (requires additional WebSocket setup)
-                    res.status(426).send("WebSocket support not yet implemented");
-                    return [2 /*return*/];
-                }
-                // For regular HTTP requests to the MCP endpoint
-                if (req.method === "GET") {
-                    res.json({
-                        name: "api-docs-mcp-server",
-                        version: "1.0.0",
-                        description: "MCP server providing API documentation tools",
-                        tools: endpoints.length,
-                        endpoints: endpoints.map(function (e) { return ({
-                            path: e.path,
-                            method: e.method,
-                            description: e.description,
-                        }); }),
-                    });
-                    return [2 /*return*/];
-                }
-                // Handle MCP protocol messages over HTTP POST
-                if (req.method === "POST") {
-                    _a = req.body, method = _a.method, params = _a.params;
-                    // Handle tools/list
-                    if (method === "tools/list") {
-                        tools = endpoints.map(function (endpoint) { return ({
-                            name: "".concat(endpoint.method.toLowerCase(), "_").concat(endpoint.path.replace(/[/:]/g, "_")),
-                            description: endpoint.description || "".concat(endpoint.method, " ").concat(endpoint.path),
-                            inputSchema: generateInputSchema(endpoint),
-                        }); });
-                        res.json({ tools: tools });
-                        return [2 /*return*/];
-                    }
-                    // Handle tools/call
-                    if (method === "tools/call") {
-                        _b = params || {}, name_1 = _b.name, args = _b.arguments;
-                        endpoint = endpoints.find(function (e) { return "".concat(e.method.toLowerCase(), "_").concat(e.path.replace(/[/:]/g, "_")) === name_1; });
-                        if (!endpoint) {
-                            res.json({
-                                content: [
-                                    {
-                                        type: "text",
-                                        text: "Tool not found: ".concat(name_1),
-                                    },
-                                ],
-                            });
-                            return [2 /*return*/];
-                        }
-                        response_1 = "Endpoint Details:\n";
-                        response_1 += "Path: ".concat(endpoint.path, "\n");
-                        response_1 += "Method: ".concat(endpoint.method, "\n");
-                        if (endpoint.description) {
-                            response_1 += "Description: ".concat(endpoint.description, "\n");
-                        }
-                        if (endpoint.pathParams && endpoint.pathParams.length > 0) {
-                            response_1 += "\nPath Parameters:\n";
-                            endpoint.pathParams.forEach(function (param) {
-                                response_1 += "- ".concat(param.name, ": ").concat(param.description || "No description", "\n");
-                            });
-                        }
-                        if (endpoint.queryParams && endpoint.queryParams.length > 0) {
-                            response_1 += "\nQuery Parameters:\n";
-                            endpoint.queryParams.forEach(function (param) {
-                                response_1 += "- ".concat(param.name).concat(param.required ? " (required)" : "", ": ").concat(param.type || "string", " - ").concat(param.description || "No description", "\n");
-                            });
-                        }
-                        if (endpoint.requestBody && endpoint.requestBody.length > 0) {
-                            response_1 += "\nRequest Body Schema:\n";
-                            response_1 += JSON.stringify(endpoint.requestBody, null, 2);
-                        }
-                        if (endpoint.responseBody && endpoint.responseBody.length > 0) {
-                            response_1 += "\nResponse Body Schema:\n";
-                            response_1 += JSON.stringify(endpoint.responseBody, null, 2);
-                        }
-                        res.json({
-                            content: [
-                                {
-                                    type: "text",
-                                    text: response_1,
-                                },
-                            ],
-                        });
-                        return [2 /*return*/];
-                    }
-                    res.status(400).json({
-                        error: "Unknown method",
-                        details: "Method ".concat(method, " is not supported"),
-                    });
-                    return [2 /*return*/];
-                }
-                res.status(405).send("Method not allowed");
-            }
-            catch (error) {
-                console.error("MCP handler error:", error);
-                res.status(500).send("Internal server error");
-            }
-            return [2 /*return*/];
-        });
-    }); };
-}
-exports.createMcpHandler = createMcpHandler;
-function generateInputSchema(endpoint) {
-    var inputSchema = {
-        type: "object",
-        properties: {},
-        required: [],
-    };
-    // Add path parameters
-    if (endpoint.pathParams && endpoint.pathParams.length > 0) {
-        endpoint.pathParams.forEach(function (param) {
-            inputSchema.properties[param.name] = {
-                type: "string",
-                description: param.description || "Path parameter: ".concat(param.name),
-            };
-            inputSchema.required.push(param.name);
-        });
-    }
-    // Add query parameters
-    if (endpoint.queryParams && endpoint.queryParams.length > 0) {
-        endpoint.queryParams.forEach(function (param) {
-            inputSchema.properties[param.name] = {
-                type: param.type || "string",
-                description: param.description || "Query parameter: ".concat(param.name),
-            };
-            if (param.required) {
-                inputSchema.required.push(param.name);
-            }
-        });
-    }
-    // Add request body
-    if (endpoint.requestBody && endpoint.requestBody.length > 0) {
-        var requestBodySchema_1 = {
-            type: "object",
-            properties: {},
-            required: [],
-        };
-        // Convert flat properties back to nested structure for schema
-        endpoint.requestBody.forEach(function (prop) {
-            var parts = prop.name.split(".");
-            var current = requestBodySchema_1.properties;
-            for (var i = 0; i < parts.length - 1; i++) {
-                var part = parts[i];
-                if (!current[part]) {
-                    current[part] = {
-                        type: "object",
-                        properties: {},
-                    };
-                }
-                current = current[part].properties;
-            }
-            var lastPart = parts[parts.length - 1];
-            current[lastPart] = {
-                type: prop.type,
-                description: prop.description,
-            };
-            if (prop.required) {
-                requestBodySchema_1.required.push(parts[0]);
-            }
-        });
-        inputSchema.properties.body = requestBodySchema_1;
-        inputSchema.required.push("body");
-    }
-    return inputSchema;
-}