@pikku/inspector 0.11.1 → 0.12.0

package/dist/add/add-mcp-tool.js

@@ -1,81 +0,0 @@
-import * as ts from 'typescript';
-import { getPropertyValue, getCommonWireMetaData, } from '../utils/get-property-value.js';
-import { extractWireNames } from '../utils/post-process.js';
-import { ensureFunctionMetadata } from '../utils/ensure-function-metadata.js';
-import { extractFunctionName } from '../utils/extract-function-name.js';
-import { getPropertyAssignmentInitializer } from '../utils/type-utils.js';
-import { resolveMiddleware } from '../utils/middleware.js';
-import { resolvePermissions } from '../utils/permissions.js';
-import { ErrorCode } from '../error-codes.js';
-export const addMCPTool = (logger, node, checker, state, options) => {
-    if (!ts.isCallExpression(node)) {
-        return;
-    }
-    const args = node.arguments;
-    const firstArg = args[0];
-    const expression = node.expression;
-    // Check if the call is to wireMCPTool
-    if (!ts.isIdentifier(expression) || expression.text !== 'wireMCPTool') {
-        return;
-    }
-    if (!firstArg) {
-        return;
-    }
-    if (ts.isObjectLiteralExpression(firstArg)) {
-        const obj = firstArg;
-        const nameValue = getPropertyValue(obj, 'name');
-        const titleValue = getPropertyValue(obj, 'title');
-        const { tags, summary, description, errors } = getCommonWireMetaData(obj, 'MCP tool', nameValue, logger);
-        const streamingValue = getPropertyValue(obj, 'streaming');
-        if (streamingValue === true) {
-            logger.warn(`MCP tool '${nameValue}' has streaming enabled, but streaming is not yet supported.`);
-        }
-        const funcInitializer = getPropertyAssignmentInitializer(obj, 'func', true, checker);
-        if (!funcInitializer) {
-            logger.critical(ErrorCode.MISSING_FUNC, `No valid 'func' property for MCP tool '${nameValue}'.`);
-            return;
-        }
-        const pikkuFuncName = extractFunctionName(funcInitializer, checker, state.rootDir).pikkuFuncName;
-        // Ensure function metadata exists (creates stub for inline functions)
-        ensureFunctionMetadata(state, pikkuFuncName, nameValue || undefined);
-        if (!nameValue) {
-            logger.critical(ErrorCode.MISSING_NAME, "MCP tool is missing the required 'name' property.");
-            return;
-        }
-        if (!description) {
-            logger.critical(ErrorCode.MISSING_DESCRIPTION, `MCP tool '${nameValue}' is missing a description.`);
-            return;
-        }
-        // lookup existing function metadata
-        const fnMeta = state.functions.meta[pikkuFuncName];
-        if (!fnMeta) {
-            logger.critical(ErrorCode.FUNCTION_METADATA_NOT_FOUND, `No function metadata found for '${pikkuFuncName}'.`);
-            return;
-        }
-        const inputSchema = fnMeta.inputs?.[0] || null;
-        const outputSchema = fnMeta.outputs?.[0] || null;
-        // --- resolve middleware ---
-        const middleware = resolveMiddleware(state, obj, tags, checker);
-        // --- resolve permissions ---
-        const permissions = resolvePermissions(state, obj, tags, checker);
-        // --- track used functions/middleware/permissions for service aggregation ---
-        state.serviceAggregation.usedFunctions.add(pikkuFuncName);
-        extractWireNames(middleware).forEach((name) => state.serviceAggregation.usedMiddleware.add(name));
-        extractWireNames(permissions).forEach((name) => state.serviceAggregation.usedPermissions.add(name));
-        state.mcpEndpoints.files.add(node.getSourceFile().fileName);
-        state.mcpEndpoints.toolsMeta[nameValue] = {
-            pikkuFuncName,
-            name: nameValue,
-            title: titleValue || undefined,
-            description,
-            summary,
-            errors,
-            ...(streamingValue !== null && { streaming: streamingValue }),
-            tags,
-            inputSchema,
-            outputSchema,
-            middleware,
-            permissions,
-        };
-    }
-};

package/dist/utils/extract-service-metadata.d.ts

@@ -1,19 +0,0 @@
-import * as ts from 'typescript';
-export interface ServiceMetadata {
-    name: string;
-    summary: string;
-    description: string;
-    package: string;
-    path: string;
-    version: string;
-    interface: string;
-    expandedProperties: Record<string, string>;
-}
-/**
- * Extract metadata for a service from its TypeScript declaration
- */
-export declare function extractServiceMetadata(serviceName: string, type: ts.Type, checker: ts.TypeChecker, rootDir: string): ServiceMetadata | null;
-/**
- * Extract metadata for all services in a type
- */
-export declare function extractAllServiceMetadata(servicesType: ts.Type, checker: ts.TypeChecker, rootDir: string): ServiceMetadata[];

package/dist/utils/extract-service-metadata.js

@@ -1,244 +0,0 @@
-import * as ts from 'typescript';
-import * as path from 'path';
-import * as fs from 'fs';
-/**
- * Extract JSDoc comment information from a TypeScript node
- */
-function extractJSDoc(node) {
-    const jsDocTags = ts.getJSDocTags(node);
-    const jsDocComments = ts.getJSDocCommentsAndTags(node);
-    let summary = '';
-    let description = '';
-    const summaryTag = jsDocTags.find((tag) => tag.tagName.text === 'summary');
-    if (summaryTag && summaryTag.comment) {
-        summary =
-            typeof summaryTag.comment === 'string'
-                ? summaryTag.comment
-                : summaryTag.comment.map((c) => c.text).join('');
-    }
-    for (const comment of jsDocComments) {
-        if (ts.isJSDoc(comment) && comment.comment) {
-            const commentText = typeof comment.comment === 'string'
-                ? comment.comment
-                : comment.comment.map((c) => c.text).join('');
-            if (!summary && commentText) {
-                const lines = commentText
-                    .split('\n')
-                    .map((l) => l.trim())
-                    .filter(Boolean);
-                if (lines.length > 0) {
-                    summary = lines[0];
-                    if (lines.length > 1) {
-                        description = lines.slice(1).join('\n').trim();
-                    }
-                }
-            }
-            else {
-                description = commentText;
-            }
-            break;
-        }
-    }
-    return { summary, description };
-}
-/**
- * Serialize a TypeScript type to a string representation
- */
-function serializeTypeToString(node, sourceFile, checker) {
-    const nodeSourceFile = node.getSourceFile();
-    if (ts.isInterfaceDeclaration(node) || ts.isTypeAliasDeclaration(node)) {
-        return node.getText(nodeSourceFile);
-    }
-    if (ts.isClassDeclaration(node)) {
-        return serializePublicClassMembers(node, nodeSourceFile, checker);
-    }
-    const type = checker.getTypeAtLocation(node);
-    return checker.typeToString(type, node, ts.TypeFormatFlags.NoTruncation);
-}
-/**
- * Extract public members from a class and serialize them
- */
-function serializePublicClassMembers(classNode, sourceFile, checker) {
-    const className = classNode.name?.text || 'UnnamedClass';
-    const publicMembers = [];
-    for (const member of classNode.members) {
-        const modifiers = ts.canHaveModifiers(member)
-            ? ts.getModifiers(member)
-            : undefined;
-        const isPublic = !modifiers?.some((mod) => mod.kind === ts.SyntaxKind.PrivateKeyword ||
-            mod.kind === ts.SyntaxKind.ProtectedKeyword);
-        if (!isPublic)
-            continue;
-        if (ts.isMethodDeclaration(member) ||
-            ts.isPropertyDeclaration(member) ||
-            ts.isConstructorDeclaration(member)) {
-            const memberSignature = getMemberSignature(member, sourceFile, checker);
-            if (memberSignature) {
-                publicMembers.push(memberSignature);
-            }
-        }
-    }
-    return `class ${className} {\n  ${publicMembers.join('\n  ')}\n}`;
-}
-/**
- * Extract a clean signature for a class member (without implementation)
- */
-function getMemberSignature(member, sourceFile, checker) {
-    if (ts.isPropertyDeclaration(member)) {
-        const name = member.name.getText(sourceFile);
-        const type = member.type ? member.type.getText(sourceFile) : 'any';
-        const optional = member.questionToken ? '?' : '';
-        return `${name}${optional}: ${type};`;
-    }
-    if (ts.isMethodDeclaration(member)) {
-        const name = member.name.getText(sourceFile);
-        const typeParams = member.typeParameters
-            ? `<${member.typeParameters.map((tp) => tp.getText(sourceFile)).join(', ')}>`
-            : '';
-        const params = member.parameters
-            .map((p) => p.getText(sourceFile))
-            .join(', ');
-        const returnType = member.type ? member.type.getText(sourceFile) : 'void';
-        const optional = member.questionToken ? '?' : '';
-        return `${name}${optional}${typeParams}(${params}): ${returnType};`;
-    }
-    if (ts.isConstructorDeclaration(member)) {
-        const params = member.parameters
-            .map((p) => p.getText(sourceFile))
-            .join(', ');
-        return `constructor(${params});`;
-    }
-    return null;
-}
-/**
- * Find the nearest package.json and extract package name and version
- */
-function getPackageInfo(filePath) {
-    let currentDir = path.dirname(filePath);
-    const root = path.parse(currentDir).root;
-    while (currentDir !== root) {
-        const packageJsonPath = path.join(currentDir, 'package.json');
-        if (fs.existsSync(packageJsonPath)) {
-            try {
-                const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
-                return {
-                    packageName: packageJson.name || 'unknown',
-                    version: packageJson.version || '0.0.0',
-                };
-            }
-            catch (err) {
-                // If we can't parse the package.json, continue searching
-            }
-        }
-        currentDir = path.dirname(currentDir);
-    }
-    return { packageName: 'unknown', version: '0.0.0' };
-}
-/**
- * Expand a type to show all its properties including inherited ones
- * Returns a Record mapping property names to their type strings
- */
-function expandInterfaceProperties(type, checker, maxDepth = 2, currentDepth = 0, visited = new Set()) {
-    const result = {};
-    if (visited.has(type) || currentDepth >= maxDepth) {
-        return result;
-    }
-    visited.add(type);
-    const properties = type.getProperties();
-    for (const prop of properties) {
-        const propName = prop.getName();
-        const propDecl = prop.valueDeclaration || prop.declarations?.[0];
-        if (!propDecl)
-            continue;
-        try {
-            const propType = checker.getTypeOfSymbolAtLocation(prop, propDecl);
-            const isOptional = !!(prop.flags & ts.SymbolFlags.Optional);
-            let typeString = checker.typeToString(propType, propDecl, ts.TypeFormatFlags.NoTruncation |
-                ts.TypeFormatFlags.UseFullyQualifiedType);
-            if (isOptional && !typeString.includes('undefined')) {
-                typeString = `${typeString} | undefined`;
-            }
-            result[propName] = typeString;
-        }
-        catch (err) {
-            result[propName] = 'any';
-        }
-    }
-    return result;
-}
-/**
- * Extract metadata for a service from its TypeScript declaration
- */
-export function extractServiceMetadata(serviceName, type, checker, rootDir) {
-    const property = type.getProperty(serviceName);
-    if (!property) {
-        return null;
-    }
-    const declaration = property.valueDeclaration || property.declarations?.[0];
-    if (!declaration) {
-        return null;
-    }
-    const sourceFile = declaration.getSourceFile();
-    const filePath = sourceFile.fileName;
-    const serviceType = checker.getTypeOfSymbolAtLocation(property, declaration);
-    let typeDeclaration = null;
-    if (serviceType.symbol) {
-        const typeDecl = serviceType.symbol.valueDeclaration ||
-            serviceType.symbol.declarations?.[0];
-        if (typeDecl &&
-            (ts.isInterfaceDeclaration(typeDecl) ||
-                ts.isClassDeclaration(typeDecl) ||
-                ts.isTypeAliasDeclaration(typeDecl))) {
-            typeDeclaration = typeDecl;
-        }
-    }
-    let summary = '';
-    let description = '';
-    if (typeDeclaration) {
-        const jsDoc = extractJSDoc(typeDeclaration);
-        summary = jsDoc.summary;
-        description = jsDoc.description;
-    }
-    else if (ts.isPropertySignature(declaration) ||
-        ts.isPropertyDeclaration(declaration)) {
-        const jsDoc = extractJSDoc(declaration);
-        summary = jsDoc.summary;
-        description = jsDoc.description;
-    }
-    let interfaceString = '';
-    if (typeDeclaration) {
-        interfaceString = serializeTypeToString(typeDeclaration, sourceFile, checker);
-    }
-    else {
-        interfaceString = checker.typeToString(serviceType, declaration, ts.TypeFormatFlags.NoTruncation);
-    }
-    const { packageName, version } = getPackageInfo(filePath);
-    const relativePath = path.relative(rootDir, filePath);
-    const expandedProperties = expandInterfaceProperties(serviceType, checker);
-    return {
-        name: serviceName,
-        summary,
-        description,
-        package: packageName,
-        path: relativePath,
-        version,
-        interface: interfaceString,
-        expandedProperties,
-    };
-}
-/**
- * Extract metadata for all services in a type
- */
-export function extractAllServiceMetadata(servicesType, checker, rootDir) {
-    const metadata = [];
-    const serviceNames = servicesType
-        .getProperties()
-        .map((prop) => prop.getName());
-    for (const serviceName of serviceNames) {
-        const serviceMeta = extractServiceMetadata(serviceName, servicesType, checker, rootDir);
-        if (serviceMeta) {
-            metadata.push(serviceMeta);
-        }
-    }
-    return metadata;
-}

package/dist/utils/write-service-metadata.d.ts

@@ -1,13 +0,0 @@
-import { ServiceMetadata } from './extract-service-metadata.js';
-/**
- * Write service metadata to a JSON file in .pikku/services directory
- */
-export declare function writeServiceMetadata(serviceMeta: ServiceMetadata, outDir: string): void;
-/**
- * Write all service metadata files
- */
-export declare function writeAllServiceMetadata(servicesMetadata: ServiceMetadata[], outDir: string): void;
-/**
- * Clean up services directory (remove old service JSON files)
- */
-export declare function cleanServicesDirectory(outDir: string): void;

package/dist/utils/write-service-metadata.js

@@ -1,37 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-/**
- * Write service metadata to a JSON file in .pikku/services directory
- */
-export function writeServiceMetadata(serviceMeta, outDir) {
-    const servicesDir = path.join(outDir, 'services');
-    if (!fs.existsSync(servicesDir)) {
-        fs.mkdirSync(servicesDir, { recursive: true });
-    }
-    const fileName = `${serviceMeta.name}.gen.json`;
-    const filePath = path.join(servicesDir, fileName);
-    const jsonContent = JSON.stringify(serviceMeta, null, 2);
-    fs.writeFileSync(filePath, jsonContent, 'utf-8');
-}
-/**
- * Write all service metadata files
- */
-export function writeAllServiceMetadata(servicesMetadata, outDir) {
-    for (const serviceMeta of servicesMetadata) {
-        writeServiceMetadata(serviceMeta, outDir);
-    }
-}
-/**
- * Clean up services directory (remove old service JSON files)
- */
-export function cleanServicesDirectory(outDir) {
-    const servicesDir = path.join(outDir, 'services');
-    if (fs.existsSync(servicesDir)) {
-        const files = fs.readdirSync(servicesDir);
-        for (const file of files) {
-            if (file.endsWith('.gen.json')) {
-                fs.unlinkSync(path.join(servicesDir, file));
-            }
-        }
-    }
-}

package/src/add/add-mcp-tool.ts

@@ -1,141 +0,0 @@
-import * as ts from 'typescript'
-import {
-  getPropertyValue,
-  getCommonWireMetaData,
-} from '../utils/get-property-value.js'
-import { extractWireNames } from '../utils/post-process.js'
-import { ensureFunctionMetadata } from '../utils/ensure-function-metadata.js'
-import { AddWiring } from '../types.js'
-import { extractFunctionName } from '../utils/extract-function-name.js'
-import { getPropertyAssignmentInitializer } from '../utils/type-utils.js'
-import { resolveMiddleware } from '../utils/middleware.js'
-import { resolvePermissions } from '../utils/permissions.js'
-import { ErrorCode } from '../error-codes.js'
-
-export const addMCPTool: AddWiring = (
-  logger,
-  node,
-  checker,
-  state,
-  options
-) => {
-  if (!ts.isCallExpression(node)) {
-    return
-  }
-
-  const args = node.arguments
-  const firstArg = args[0]
-  const expression = node.expression
-
-  // Check if the call is to wireMCPTool
-  if (!ts.isIdentifier(expression) || expression.text !== 'wireMCPTool') {
-    return
-  }
-
-  if (!firstArg) {
-    return
-  }
-
-  if (ts.isObjectLiteralExpression(firstArg)) {
-    const obj = firstArg
-
-    const nameValue = getPropertyValue(obj, 'name') as string | null
-    const titleValue = getPropertyValue(obj, 'title') as string | null
-    const { tags, summary, description, errors } = getCommonWireMetaData(
-      obj,
-      'MCP tool',
-      nameValue,
-      logger
-    )
-    const streamingValue = getPropertyValue(obj, 'streaming') as boolean | null
-
-    if (streamingValue === true) {
-      logger.warn(
-        `MCP tool '${nameValue}' has streaming enabled, but streaming is not yet supported.`
-      )
-    }
-
-    const funcInitializer = getPropertyAssignmentInitializer(
-      obj,
-      'func',
-      true,
-      checker
-    )
-    if (!funcInitializer) {
-      logger.critical(
-        ErrorCode.MISSING_FUNC,
-        `No valid 'func' property for MCP tool '${nameValue}'.`
-      )
-      return
-    }
-
-    const pikkuFuncName = extractFunctionName(
-      funcInitializer,
-      checker,
-      state.rootDir
-    ).pikkuFuncName
-
-    // Ensure function metadata exists (creates stub for inline functions)
-    ensureFunctionMetadata(state, pikkuFuncName, nameValue || undefined)
-
-    if (!nameValue) {
-      logger.critical(
-        ErrorCode.MISSING_NAME,
-        "MCP tool is missing the required 'name' property."
-      )
-      return
-    }
-
-    if (!description) {
-      logger.critical(
-        ErrorCode.MISSING_DESCRIPTION,
-        `MCP tool '${nameValue}' is missing a description.`
-      )
-      return
-    }
-
-    // lookup existing function metadata
-    const fnMeta = state.functions.meta[pikkuFuncName]
-    if (!fnMeta) {
-      logger.critical(
-        ErrorCode.FUNCTION_METADATA_NOT_FOUND,
-        `No function metadata found for '${pikkuFuncName}'.`
-      )
-      return
-    }
-    const inputSchema = fnMeta.inputs?.[0] || null
-    const outputSchema = fnMeta.outputs?.[0] || null
-
-    // --- resolve middleware ---
-    const middleware = resolveMiddleware(state, obj, tags, checker)
-
-    // --- resolve permissions ---
-    const permissions = resolvePermissions(state, obj, tags, checker)
-
-    // --- track used functions/middleware/permissions for service aggregation ---
-    state.serviceAggregation.usedFunctions.add(pikkuFuncName)
-    extractWireNames(middleware).forEach((name) =>
-      state.serviceAggregation.usedMiddleware.add(name)
-    )
-    extractWireNames(permissions).forEach((name) =>
-      state.serviceAggregation.usedPermissions.add(name)
-    )
-
-    state.mcpEndpoints.files.add(node.getSourceFile().fileName)
-
-    state.mcpEndpoints.toolsMeta[nameValue] = {
-      pikkuFuncName,
-      name: nameValue,
-      title: titleValue || undefined,
-      description,
-      summary,
-      errors,
-      ...(streamingValue !== null && { streaming: streamingValue }),
-      tags,
-      inputSchema,
-      outputSchema,
-      middleware,
-      permissions,
-    }
-  }
-}