foundryvtt-mcp 0.11.0

package/dist/diagnostics/client.js

@@ -0,0 +1,314 @@
+/**
+ * @fileoverview DiagnosticsClient for accessing FoundryVTT logs and system health
+ *
+ * This module provides a client interface for accessing diagnostic information
+ * from FoundryVTT through the REST API module's diagnostic endpoints.
+ *
+ * @version 0.1.0
+ * @author FoundryVTT MCP Team
+ */
+import { logger } from '../utils/logger.js';
+import { ErrorDiagnosisSchema, LogResponseSchema, LogSearchResponseSchema, SystemHealthSchema, } from './types.js';
+/**
+ * Client for accessing FoundryVTT diagnostic and logging information
+ *
+ * Provides methods to retrieve logs, search for specific patterns,
+ * monitor system health, and analyze errors through the REST API.
+ *
+ * @class DiagnosticsClient
+ * @example
+ * ```typescript
+ * const diagnostics = new DiagnosticsClient(foundryClient);
+ *
+ * // Get recent errors
+ * const errors = await diagnostics.getRecentLogs({ level: 'error', lines: 20 });
+ *
+ * // Search for specific patterns
+ * const matches = await diagnostics.searchLogs({ pattern: 'TypeError', timeframe: '3600' });
+ *
+ * // Check system health
+ * const health = await diagnostics.getSystemHealth();
+ * ```
+ */
+export class DiagnosticsClient {
+    foundryClient;
+    /**
+     * Create a new DiagnosticsClient instance
+     *
+     * @param foundryClient - The FoundryClient instance to use for API calls
+     */
+    constructor(foundryClient) {
+        this.foundryClient = foundryClient;
+    }
+    /**
+     * Get recent log entries with optional filtering
+     *
+     * @param params - Search parameters for filtering logs
+     * @returns Promise resolving to log response with entries and metadata
+     *
+     * @example
+     * ```typescript
+     * // Get last 50 log entries
+     * const logs = await diagnostics.getRecentLogs();
+     *
+     * // Get only error logs from the last hour
+     * const errors = await diagnostics.getRecentLogs({
+     *   level: 'error',
+     *   since: new Date(Date.now() - 3600000).toISOString()
+     * });
+     *
+     * // Get logs with stack traces included
+     * const detailed = await diagnostics.getRecentLogs({
+     *   lines: 100,
+     *   includeStack: true
+     * });
+     * ```
+     */
+    async getRecentLogs(params = {}) {
+        try {
+            logger.debug('DiagnosticsClient | Getting recent logs', params);
+            const searchParams = new URLSearchParams();
+            if (params.lines !== undefined) {
+                searchParams.set('lines', params.lines.toString());
+            }
+            if (params.level) {
+                searchParams.set('level', params.level);
+            }
+            if (params.since) {
+                searchParams.set('since', params.since);
+            }
+            if (params.source) {
+                searchParams.set('source', params.source);
+            }
+            if (params.includeStack !== undefined) {
+                searchParams.set('includeStack', params.includeStack.toString());
+            }
+            const queryString = searchParams.toString();
+            const url = `/api/diagnostics/logs${queryString ? `?${queryString}` : ''}`;
+            const response = await this.foundryClient.get(url);
+            const parsed = LogResponseSchema.parse(response.data);
+            logger.debug('DiagnosticsClient | Retrieved logs', {
+                count: parsed.total,
+                bufferSize: parsed.bufferSize,
+            });
+            return parsed;
+        }
+        catch (error) {
+            logger.error('DiagnosticsClient | Failed to get recent logs:', error);
+            throw new Error(`Failed to retrieve recent logs: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
+    /**
+     * Search log entries for specific patterns using regular expressions
+     *
+     * @param params - Search parameters including pattern and filters
+     * @returns Promise resolving to matching log entries
+     *
+     * @example
+     * ```typescript
+     * // Search for any TypeError occurrences
+     * const typeErrors = await diagnostics.searchLogs({
+     *   pattern: 'TypeError'
+     * });
+     *
+     * // Search for network errors in the last hour
+     * const networkErrors = await diagnostics.searchLogs({
+     *   pattern: 'Failed to fetch|Network Error',
+     *   timeframe: '3600',
+     *   level: 'error'
+     * });
+     *
+     * // Case-sensitive search for specific module errors
+     * const moduleErrors = await diagnostics.searchLogs({
+     *   pattern: 'Module.*failed',
+     *   caseSensitive: true
+     * });
+     * ```
+     */
+    async searchLogs(params) {
+        try {
+            logger.debug('DiagnosticsClient | Searching logs', params);
+            const searchParams = new URLSearchParams();
+            searchParams.set('pattern', params.pattern);
+            if (params.timeframe) {
+                searchParams.set('timeframe', params.timeframe);
+            }
+            if (params.level) {
+                searchParams.set('level', params.level);
+            }
+            if (params.caseSensitive !== undefined) {
+                searchParams.set('caseSensitive', params.caseSensitive.toString());
+            }
+            const url = `/api/diagnostics/search?${searchParams.toString()}`;
+            const response = await this.foundryClient.get(url);
+            const parsed = LogSearchResponseSchema.parse(response.data);
+            logger.debug('DiagnosticsClient | Search completed', {
+                pattern: params.pattern,
+                matches: parsed.matches,
+            });
+            return parsed;
+        }
+        catch (error) {
+            logger.error('DiagnosticsClient | Failed to search logs:', error);
+            throw new Error(`Failed to search logs: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
+    /**
+     * Get comprehensive system health and performance metrics
+     *
+     * @returns Promise resolving to complete system health information
+     *
+     * @example
+     * ```typescript
+     * const health = await diagnostics.getSystemHealth();
+     *
+     * console.log(`Server status: ${health.status}`);
+     * console.log(`Active users: ${health.users.active}/${health.users.total}`);
+     * console.log(`Recent errors: ${health.logs.recentErrors}`);
+     * console.log(`Health score: ${health.healthScore}%`);
+     *
+     * if (health.status === 'critical') {
+     *   console.warn('Server requires immediate attention!');
+     * }
+     * ```
+     */
+    async getSystemHealth() {
+        try {
+            logger.debug('DiagnosticsClient | Getting system health');
+            const response = await this.foundryClient.get('/api/diagnostics/health');
+            const parsed = SystemHealthSchema.parse(response.data);
+            logger.debug('DiagnosticsClient | System health retrieved', {
+                status: parsed.status,
+                activeUsers: parsed.users?.active,
+                recentErrors: parsed.logs?.recentErrors,
+            });
+            return parsed;
+        }
+        catch (error) {
+            logger.error('DiagnosticsClient | Failed to get system health:', error);
+            throw new Error(`Failed to retrieve system health: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
+    /**
+     * Analyze recent errors and get diagnostic suggestions
+     *
+     * @param timeframe - Time window in seconds to analyze (default: 3600)
+     * @returns Promise resolving to error diagnosis with suggestions
+     *
+     * @example
+     * ```typescript
+     * // Analyze errors from the last hour
+     * const diagnosis = await diagnostics.diagnoseErrors();
+     *
+     * // Analyze errors from the last 30 minutes
+     * const recentDiagnosis = await diagnostics.diagnoseErrors(1800);
+     *
+     * console.log(`Health score: ${diagnosis.healthScore}/100`);
+     * console.log(`Total errors: ${diagnosis.summary.totalErrors}`);
+     *
+     * // Display suggestions
+     * diagnosis.suggestions.forEach(suggestion => {
+     *   console.log(`${suggestion.priority.toUpperCase()}: ${suggestion.suggestion}`);
+     * });
+     * ```
+     */
+    async diagnoseErrors(timeframe = 3600) {
+        try {
+            logger.debug('DiagnosticsClient | Diagnosing errors', { timeframe });
+            const searchParams = new URLSearchParams();
+            searchParams.set('timeframe', timeframe.toString());
+            const url = `/api/diagnostics/errors?${searchParams.toString()}`;
+            const response = await this.foundryClient.get(url);
+            const parsed = ErrorDiagnosisSchema.parse(response.data);
+            logger.debug('DiagnosticsClient | Error diagnosis completed', {
+                totalErrors: parsed.summary?.totalErrors,
+                healthScore: parsed.healthScore,
+                suggestionCount: parsed.suggestions?.length,
+            });
+            return parsed;
+        }
+        catch (error) {
+            logger.error('DiagnosticsClient | Failed to diagnose errors:', error);
+            throw new Error(`Failed to diagnose errors: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
+    /**
+     * Get errors filtered by severity and time window
+     *
+     * @param timeframe - Time window in seconds (default: 3600)
+     * @param level - Log level to filter by (default: 'error')
+     * @returns Promise resolving to filtered log entries
+     *
+     * @example
+     * ```typescript
+     * // Get all errors from the last 2 hours
+     * const errors = await diagnostics.getErrorsOnly(7200);
+     *
+     * // Get warnings from the last 30 minutes
+     * const warnings = await diagnostics.getErrorsOnly(1800, 'warn');
+     * ```
+     */
+    async getErrorsOnly(timeframe = 3600, level = 'error') {
+        try {
+            const since = new Date(Date.now() - timeframe * 1000).toISOString();
+            const response = await this.getRecentLogs({
+                level,
+                since,
+                lines: 1000, // Get a large number to ensure we capture all errors
+                includeStack: true,
+            });
+            return response.logs;
+        }
+        catch (error) {
+            logger.error('DiagnosticsClient | Failed to get errors only:', error);
+            throw new Error(`Failed to retrieve ${level} logs: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
+    /**
+     * Monitor system health and return status summary
+     *
+     * @returns Promise resolving to simplified health status
+     *
+     * @example
+     * ```typescript
+     * const status = await diagnostics.getHealthStatus();
+     * // Returns: { status: 'healthy' | 'warning' | 'critical', score: number }
+     * ```
+     */
+    async getHealthStatus() {
+        try {
+            const health = await this.getSystemHealth();
+            return {
+                status: health.status,
+            };
+        }
+        catch (error) {
+            logger.error('DiagnosticsClient | Failed to get health status:', error);
+            return { status: 'critical' };
+        }
+    }
+    /**
+     * Check if diagnostics API is available
+     *
+     * @returns Promise resolving to boolean indicating availability
+     *
+     * @example
+     * ```typescript
+     * const available = await diagnostics.isAvailable();
+     * if (!available) {
+     *   console.log('Diagnostics API not available - check module installation');
+     * }
+     * ```
+     */
+    async isAvailable() {
+        try {
+            await this.foundryClient.get('/api/diagnostics/health');
+            return true;
+        }
+        catch (error) {
+            logger.debug('DiagnosticsClient | Diagnostics API not available:', error);
+            return false;
+        }
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/diagnostics/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/diagnostics/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EACL,oBAAoB,EAEpB,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAQpB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,iBAAiB;IAMR;IALpB;;;;OAIG;IACH,YAAoB,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;IAAG,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,aAAa,CAAC,SAA0B,EAAE;QAC9C,IAAI,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;YAEhE,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;YAE3C,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC5C,CAAC;YACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACtC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;YACnE,CAAC;YAED,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC5C,MAAM,GAAG,GAAG,wBAAwB,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YAE3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEtD,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE;gBACjD,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAC;YACtE,MAAM,IAAI,KAAK,CACb,mCAAmC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAC9F,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,UAAU,CAAC,MAA8B;QAC7C,IAAI,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;YAE3D,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;YAC3C,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YAE5C,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;YAClD,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;YACD,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACvC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrE,CAAC;YAED,MAAM,GAAG,GAAG,2BAA2B,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YACjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,uBAAuB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAE5D,MAAM,CAAC,KAAK,CAAC,sCAAsC,EAAE;gBACnD,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;YAClE,MAAM,IAAI,KAAK,CACb,0BAA0B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CACrF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,eAAe;QACnB,IAAI,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAE1D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;YACzE,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEvD,MAAM,CAAC,KAAK,CAAC,6CAA6C,EAAE;gBAC1D,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,WAAW,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM;gBACjC,YAAY,EAAE,MAAM,CAAC,IAAI,EAAE,YAAY;aACxC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,kDAAkD,EAAE,KAAK,CAAC,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,qCAAqC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAChG,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,cAAc,CAAC,YAAoB,IAAI;QAC3C,IAAI,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;YAErE,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;YAC3C,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEpD,MAAM,GAAG,GAAG,2BAA2B,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YACjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,oBAAoB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEzD,MAAM,CAAC,KAAK,CAAC,+CAA+C,EAAE;gBAC5D,WAAW,EAAE,MAAM,CAAC,OAAO,EAAE,WAAW;gBACxC,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,eAAe,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM;aAC5C,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAC;YACtE,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CACzF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,aAAa,CACjB,YAAoB,IAAI,EACxB,QAA2B,OAAO;QAElC,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;YAEpE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC;gBACxC,KAAK;gBACL,KAAK;gBACL,KAAK,EAAE,IAAI,EAAE,qDAAqD;gBAClE,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAC;YACtE,MAAM,IAAI,KAAK,CACb,sBAAsB,KAAK,UAAU,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAChG,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe;QACnB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;YAC5C,OAAO;gBACL,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,kDAAkD,EAAE,KAAK,CAAC,CAAC;YACxE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;YACxD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,oDAAoD,EAAE,KAAK,CAAC,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;CACF"}