@salesforcedevs/docs-components 1.17.0-hack-alpha8 → 1.17.2

package/src/modules/doc/commentPopup/commentDevHelper.ts

@@ -1,380 +0,0 @@
-// Development Helper for Comment Management
-// This file provides a simple interface to manage comments during development
-// You can use this in the browser console or create a simple UI for it
-
-import {
-    exportCommentsToFile,
-    importCommentsFromFile,
-    getAllComments,
-    clearAllComments,
-    getCommentsStats,
-    convertToApiFormat,
-    addComment,
-    getCommentsForBranch,
-    fetchCommentsForBranch,
-    extractCommentsFromApiResponse
-} from "./commentUtils";
-
-// Make functions available globally for console access
-if (typeof window !== "undefined") {
-    (window as any).CommentDevHelper = {
-        exportCommentsToFile,
-        importCommentsFromFile,
-        getAllComments,
-        clearAllComments,
-        getCommentsStats,
-        convertToApiFormat,
-        addComment,
-        getCommentsForBranch,
-        fetchCommentsForBranch,
-        extractCommentsFromApiResponse,
-        checkApiAvailability
-    };
-}
-
-/**
- * Create a simple UI for managing comments during development
- */
-export function createDevUI(): void {
-    if (typeof document === "undefined") {
-        return;
-    }
-
-    // Check if UI already exists
-    if (document.getElementById("comment-dev-ui")) {
-        return;
-    }
-
-    const ui = document.createElement("div");
-    ui.id = "comment-dev-ui";
-    ui.style.cssText = `
-        position: fixed;
-        top: 20px;
-        right: 20px;
-        width: 350px;
-        background: white;
-        border: 2px solid #007bff;
-        border-radius: 8px;
-        padding: 16px;
-        font-family: Arial, sans-serif;
-        font-size: 14px;
-        z-index: 10000;
-        box-shadow: 0 4px 12px rgba(0,0,0,0.15);
-        max-height: 80vh;
-        overflow-y: auto;
-    `;
-
-    const stats = getCommentsStats();
-
-    ui.innerHTML = `
-        <div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 12px;">
-            <h3 style="margin: 0; color: #007bff;">Comment Dev Helper</h3>
-            <button onclick="document.getElementById('comment-dev-ui').remove()" style="background: none; border: none; font-size: 18px; cursor: pointer;">×</button>
-        </div>
-        
-        <div style="margin-bottom: 12px;">
-            <strong>Stats:</strong><br>
-            Branches: ${stats.branches.length}<br>
-            Locations: ${stats.totalLocations}<br>
-            Total Comments: ${stats.totalComments}
-        </div>
-        
-        <div style="display: flex; flex-direction: column; gap: 8px;">
-            <button onclick="CommentDevHelper.exportCommentsToFile()" style="padding: 8px; background: #28a745; color: white; border: none; border-radius: 4px; cursor: pointer;">
-                Export Comments
-            </button>
-            
-            <button onclick="CommentDevHelper.clearAllComments()" style="padding: 8px; background: #dc3545; color: white; border: none; border-radius: 4px; cursor: pointer;">
-                Clear All Comments
-            </button>
-            
-            <button onclick="CommentDevHelper.getCommentsStats()" style="padding: 8px; background: #17a2b8; color: white; border: none; border-radius: 4px; cursor: pointer;">
-                Show Stats in Console
-            </button>
-            
-            <button onclick="console.log(CommentDevHelper.convertToApiFormat())" style="padding: 8px; background: #6f42c1; color: white; border: none; border-radius: 4px; cursor: pointer;">
-                Show API Format in Console
-            </button>
-            
-            <button onclick="CommentDevHelper.addSampleCommentsForNewApi()" style="padding: 8px; background: #fd7e14; color: white; border: none; border-radius: 4px; cursor: pointer;">
-                Add Sample Comments (New API Format)
-            </button>
-            
-            <button onclick="CommentDevHelper.testApiResponseFormat()" style="padding: 8px; background: #20c997; color: white; border: none; border-radius: 4px; cursor: pointer;">
-                Test API Response Format
-            </button>
-        </div>
-        
-        <div style="margin-top: 12px; font-size: 12px; color: #666;">
-            <strong>Console Commands:</strong><br>
-            CommentDevHelper.exportCommentsToFile()<br>
-            CommentDevHelper.clearAllComments()<br>
-            CommentDevHelper.getCommentsStats()<br>
-            CommentDevHelper.convertToApiFormat()<br>
-            CommentDevHelper.getCommentsForBranch('main')<br>
-            CommentDevHelper.testApiResponseFormat()
-        </div>
-    `;
-
-    document.body.appendChild(ui);
-}
-
-/**
- * Remove the development UI
- */
-export function removeDevUI(): void {
-    const ui = document.getElementById("comment-dev-ui");
-    if (ui) {
-        ui.remove();
-    }
-}
-
-/**
- * Add sample comments that match the new API format
- */
-export function addSampleCommentsForNewApi(): void {
-    const sampleComments = [
-        {
-            branch: "feature/documentation-updates",
-            file_path: "docs/installation.md",
-            heading_title: "Installation Guide",
-            start_line: "1",
-            end_line: "50",
-            comment: {
-                comment_text:
-                    "This installation guide is very helpful for new users.",
-                email: "john.doe@example.com",
-                timestamp: new Date(Date.now() - 3600000).toISOString() // 1 hour ago
-            }
-        },
-        {
-            branch: "feature/documentation-updates",
-            file_path: "docs/installation.md",
-            heading_title: "Installation Guide",
-            start_line: "1",
-            end_line: "50",
-            comment: {
-                comment_text:
-                    "Consider adding troubleshooting section for common issues.",
-                email: "jane.smith@example.com",
-                timestamp: new Date(Date.now() - 1800000).toISOString() // 30 minutes ago
-            }
-        },
-        {
-            branch: "feature/documentation-updates",
-            file_path: "docs/installation.md",
-            heading_title: "Prerequisites",
-            start_line: "10",
-            end_line: "25",
-            comment: {
-                comment_text:
-                    "The prerequisites section is clear and well-organized.",
-                email: "mike.wilson@example.com",
-                timestamp: new Date(Date.now() - 900000).toISOString() // 15 minutes ago
-            }
-        },
-        {
-            branch: "feature/documentation-updates",
-            file_path: "docs/api.md",
-            heading_title: "API Reference",
-            start_line: "1",
-            end_line: "100",
-            comment: {
-                comment_text:
-                    "The API documentation needs more examples for authentication.",
-                email: "sarah.jones@example.com",
-                timestamp: new Date(Date.now() - 600000).toISOString() // 10 minutes ago
-            }
-        },
-        {
-            branch: "feature/documentation-updates",
-            file_path: "docs/api.md",
-            heading_title: "API Reference",
-            start_line: "1",
-            end_line: "100",
-            comment: {
-                comment_text: "Great work on the endpoint descriptions!",
-                email: "david.brown@example.com",
-                timestamp: new Date().toISOString() // now
-            }
-        },
-        {
-            branch: "main",
-            file_path: "docs/getting-started.md",
-            heading_title: "Quick Start",
-            start_line: "1",
-            end_line: "30",
-            comment: {
-                comment_text:
-                    "This quick start guide is perfect for beginners.",
-                email: "alice.johnson@example.com",
-                timestamp: new Date(Date.now() - 7200000).toISOString() // 2 hours ago
-            }
-        }
-    ];
-
-    sampleComments.forEach((comment) => {
-        addComment(comment);
-    });
-
-    console.log("Added sample comments for new API format");
-    console.log("Sample data includes multiple branches, files, and titles");
-
-    // Refresh the page to show the new comments
-    setTimeout(() => {
-        window.location.reload();
-    }, 1000);
-}
-
-/**
- * Test the API response format
- */
-export function testApiResponseFormat(): void {
-    console.log("=== Testing API Response Format ===");
-
-    // Test with feature/documentation-updates branch
-    const featureBranchResponse = getCommentsForBranch(
-        "feature/documentation-updates"
-    );
-    console.log("Feature branch response:", featureBranchResponse);
-
-    // Test with main branch
-    const mainBranchResponse = getCommentsForBranch("main");
-    console.log("Main branch response:", mainBranchResponse);
-
-    // Test extracting specific comments
-    const installationComments = extractCommentsFromApiResponse(
-        featureBranchResponse,
-        "docs/installation.md",
-        "Installation Guide"
-    );
-    console.log("Installation Guide comments:", installationComments);
-
-    const apiComments = extractCommentsFromApiResponse(
-        featureBranchResponse,
-        "docs/api.md",
-        "API Reference"
-    );
-    console.log("API Reference comments:", apiComments);
-
-    console.log("=== API Response Format Test Complete ===");
-}
-
-/**
- * Show all comments in a formatted way in the console
- */
-export function showAllComments(): void {
-    const allComments = getAllComments();
-    console.log("=== ALL COMMENTS ===");
-    console.table(allComments);
-
-    const stats = getCommentsStats();
-    console.log("=== STATISTICS ===");
-    console.table(stats.locations);
-
-    console.log("=== BRANCHES ===");
-    console.log("Available branches:", stats.branches);
-}
-
-/**
- * Simulate API call and show response
- */
-export async function simulateApiCall(
-    branch: string = "feature/documentation-updates"
-): Promise<void> {
-    console.log(`=== Simulating API Call for branch: ${branch} ===`);
-
-    try {
-        const response = await fetchCommentsForBranch(branch);
-        console.log("API Response:", response);
-
-        // Show all paths and titles
-        response.paths.forEach((path) => {
-            console.log(`File: ${path.path}`);
-            path.titles.forEach((title) => {
-                console.log(
-                    `  Title: ${title.title} (${title.comments.length} comments)`
-                );
-            });
-        });
-    } catch (error) {
-        console.error("API call simulation failed:", error);
-    }
-}
-
-/**
- * Check if the API endpoints are available
- */
-export async function checkApiAvailability(): Promise<void> {
-    console.log("=== Checking API Availability ===");
-
-    try {
-        // Test GET endpoint
-        const getResponse = await fetch("/get-comments?branch=test");
-        console.log(
-            `GET /get-comments status: ${getResponse.status} ${getResponse.statusText}`
-        );
-
-        if (getResponse.ok) {
-            console.log("✅ GET /get-comments is available");
-        } else {
-            console.log("❌ GET /get-comments is not available");
-        }
-
-        // Test POST endpoint (with a test payload)
-        const testPayload = {
-            branch: "test",
-            file_path: "test.md",
-            heading_title: "Test",
-            start_line: "1",
-            end_line: "10",
-            comment: {
-                comment_text: "Test comment",
-                email: "test@example.com",
-                timestamp: new Date().toISOString()
-            }
-        };
-
-        const postResponse = await fetch("/post-comment", {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json"
-            },
-            body: JSON.stringify(testPayload)
-        });
-
-        console.log(
-            `POST /post-comment status: ${postResponse.status} ${postResponse.statusText}`
-        );
-
-        if (postResponse.ok) {
-            console.log("✅ POST /post-comment is available");
-        } else {
-            console.log("❌ POST /post-comment is not available");
-        }
-
-        console.log("=== API Availability Check Complete ===");
-    } catch (error) {
-        console.error("❌ API availability check failed:", error);
-        console.log("This is expected if the backend is not running");
-    }
-}
-
-// Add the helper functions to the global CommentDevHelper
-if (typeof window !== "undefined") {
-    (window as any).CommentDevHelper = {
-        ...(window as any).CommentDevHelper,
-        addSampleCommentsForNewApi,
-        testApiResponseFormat,
-        showAllComments,
-        simulateApiCall
-    };
-}
-
-// Auto-create UI when this module is imported (in development)
-if (typeof window !== "undefined" && window.location.hostname === "localhost") {
-    // Only auto-create in development environment
-    setTimeout(() => {
-        createDevUI();
-    }, 1000);
-}