@dollhousemcp/mcp-server 1.5.2 → 1.6.0

package/dist/tools/portfolio/submitToPortfolioTool.d.ts

@@ -0,0 +1,164 @@
+/**
+ * Tool for submitting content to GitHub portfolio repositories
+ * Replaces the broken issue-based submission with direct repository saves
+ *
+ * FIXES IMPLEMENTED (PR #503):
+ * 1. TYPE SAFETY FIX #1 (Issue #497): Changed apiCache from 'any' to proper APICache type
+ * 2. TYPE SAFETY FIX #2 (Issue #497): Replaced complex type casting with PortfolioElementAdapter
+ * 3. PERFORMANCE (PR #496 recommendation): Using FileDiscoveryUtil for optimized file search
+ */
+import { ElementType } from '../../portfolio/types.js';
+import { APICache } from '../../cache/APICache.js';
+import { PortfolioElementMetadata } from '../../config/portfolio-constants.js';
+export interface SubmitToPortfolioParams {
+    name: string;
+    type?: ElementType;
+}
+export interface PortfolioElement {
+    type: ElementType;
+    metadata: PortfolioElementMetadata;
+    content: string;
+}
+export interface SubmitToPortfolioResult {
+    success: boolean;
+    message: string;
+    url?: string;
+    error?: string;
+}
+export interface ElementDetectionMatch {
+    type: ElementType;
+    path: string;
+}
+export interface ElementDetectionResult {
+    found: boolean;
+    matches: ElementDetectionMatch[];
+}
+export declare class SubmitToPortfolioTool {
+    private authManager;
+    private portfolioManager;
+    private contentValidator;
+    constructor(apiCache: APICache);
+    /**
+     * Validates and normalizes input parameters to prevent Unicode attacks and ensure data safety
+     * @param params The input parameters from the user
+     * @returns Validation result with normalized name or error response
+     */
+    private validateAndNormalizeParams;
+    /**
+     * Checks if the user is authenticated with GitHub
+     * @returns Authentication check result with status or error response
+     */
+    private checkAuthentication;
+    /**
+     * Discovers content locally with smart type detection
+     * @param safeName The normalized name to search for
+     * @param explicitType Optional explicit element type provided by user
+     * @param originalName Original user-provided name for error messages
+     * @returns Content discovery result with element type and path or error response
+     */
+    private discoverContentWithTypeDetection;
+    /**
+     * Validates file size and content security before processing
+     * @param localPath Path to the local file to validate
+     * @returns Validation result with content or error response
+     */
+    private validateFileAndContent;
+    /**
+     * Prepares metadata for the portfolio element
+     * @param safeName The normalized name of the element
+     * @param elementType The type of the element
+     * @param authStatus Authentication status containing username
+     * @returns Metadata object for the element
+     */
+    private prepareElementMetadata;
+    /**
+     * Validates GitHub token and checks for expiration before usage
+     * SECURITY ENHANCEMENT (Task #5): Token expiration validation to prevent stale token usage
+     * @param token The GitHub token to validate
+     * @returns Validation result with status and expiration info
+     */
+    private validateTokenBeforeUsage;
+    /**
+     * Enhanced path validation for portfolio operations with comprehensive security checks
+     * SECURITY ENHANCEMENT (Task #7): Additional validation for special characters and malicious patterns
+     * @param filePath The file path to validate
+     * @returns Validation result with secure path or error response
+     */
+    private validatePortfolioPath;
+    /**
+     * Smart token management for long operations with refresh-like capabilities
+     * SECURITY ENHANCEMENT (Task #14): Token refresh logic for long operations
+     *
+     * Note: GitHub OAuth device flow tokens don't have traditional refresh tokens,
+     * but we can implement smart validation and guidance for long operations
+     *
+     * @param operationType Type of operation being performed
+     * @returns Token management result with recommendations
+     */
+    private manageTokenForLongOperation;
+    /**
+     * Provides user guidance for token refresh when operations fail due to token issues
+     * SECURITY ENHANCEMENT (Task #14): User guidance for authentication refresh
+     */
+    private formatTokenRefreshGuidance;
+    /**
+     * Sets up GitHub repository access and ensures portfolio repository exists
+     * @param authStatus Authentication status containing username
+     * @returns Setup result or error response
+     */
+    private setupGitHubRepository;
+    /**
+     * Submits element to portfolio and handles the complete response workflow
+     * @param safeName The normalized name of the element
+     * @param elementType The type of the element
+     * @param metadata The metadata for the element
+     * @param content The content of the element
+     * @param authStatus Authentication status containing username and token
+     * @returns Complete submission result with success message or error
+     */
+    private submitElementAndHandleResponse;
+    execute(params: SubmitToPortfolioParams): Promise<SubmitToPortfolioResult>;
+    /**
+     * Prompts user to submit content to the DollhouseMCP collection
+     * ENHANCEMENT (Issue #549): Complete the community contribution workflow
+     */
+    private promptForCollectionSubmission;
+    /**
+     * Creates an issue in the DollhouseMCP/collection repository
+     * ENHANCEMENT (Issue #549): GitHub API integration for collection submission
+     */
+    private createCollectionIssue;
+    private findLocalContent;
+    /**
+     * Smart element type detection - searches across ALL element types for content
+     * PERFORMANCE OPTIMIZATION (Task #9): Uses early termination for exact matches
+     * This replaces the previous hardcoded default to PERSONA and enables proper type detection
+     *
+     * @param name The content name to search for
+     * @returns Detection result with found matches across all element types
+     */
+    private detectElementType;
+    /**
+     * UX IMPROVEMENT: Generate name suggestions for similar content
+     * PERFORMANCE OPTIMIZATION (Task #8): Enhanced batch operation handling with clear partial failure reporting
+     * Helps users find content when exact matches fail
+     */
+    private generateNameSuggestions;
+    /**
+     * Simple similarity calculation using Levenshtein-like approach
+     * Returns value between 0 and 1, where 1 is identical
+     */
+    private calculateSimilarity;
+    /**
+     * UX IMPROVEMENT: Save element with automatic retry logic for transient failures
+     * Handles common GitHub API issues like rate limits and temporary network problems
+     */
+    private saveElementWithRetry;
+    /**
+     * Determine if an error is worth retrying
+     * Retryable: network issues, rate limits, temporary GitHub API problems
+     * Non-retryable: authentication issues, validation errors, permanent failures
+     */
+    private isRetryableError;
+}
+//# sourceMappingURL=submitToPortfolioTool.d.ts.map

package/dist/tools/portfolio/submitToPortfolioTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"submitToPortfolioTool.d.ts","sourceRoot":"","sources":["../../../src/tools/portfolio/submitToPortfolioTool.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAQH,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAKvD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAInD,OAAO,EAKL,wBAAwB,EAGzB,MAAM,qCAAqC,CAAC;AAM7C,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,wBAAwB,CAAC;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,qBAAqB,EAAE,CAAC;CAClC;AAED,qBAAa,qBAAqB;IAChC,OAAO,CAAC,WAAW,CAAoB;IACvC,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,gBAAgB,CAAmB;gBAE/B,QAAQ,EAAE,QAAQ;IAS9B;;;;OAIG;YACW,0BAA0B;IA8BxC;;;OAGG;YACW,mBAAmB;IA2BjC;;;;;;OAMG;YACW,gCAAgC;IAuH9C;;;;OAIG;YACW,sBAAsB;IA+DpC;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAe9B;;;;;OAKG;YACW,wBAAwB;IAgHtC;;;;;OAKG;YACW,qBAAqB;IA8MnC;;;;;;;;;OASG;YACW,2BAA2B;IA4GzC;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IAwBlC;;;;OAIG;YACW,qBAAqB;IA+CnC;;;;;;;;OAQG;YACW,8BAA8B;IAiGtC,OAAO,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA2FhF;;;OAGG;YACW,6BAA6B;IAgD3C;;;OAGG;YACW,qBAAqB;YA+IrB,gBAAgB;IA2G9B;;;;;;;OAOG;YACW,iBAAiB;IAoH/B;;;;OAIG;YACW,uBAAuB;IA8HrC;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAwB3B;;;OAGG;YACW,oBAAoB;IAyElC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;CAmDzB"}