@starfysh/gdrive-mcp 1.0.0

package/dist/googleDocsApiHelpers.js

@@ -0,0 +1,618 @@
+import { UserError } from 'fastmcp';
+import { hexToRgbColor, NotImplementedError } from './types.js';
+// --- Constants ---
+const MAX_BATCH_UPDATE_REQUESTS = 50; // Google API limits batch size
+// --- Core Helper to Execute Batch Updates ---
+export async function executeBatchUpdate(docs, documentId, requests) {
+    if (!requests || requests.length === 0) {
+        // console.warn("executeBatchUpdate called with no requests.");
+        return {}; // Nothing to do
+    }
+    // TODO: Consider splitting large request arrays into multiple batches if needed
+    if (requests.length > MAX_BATCH_UPDATE_REQUESTS) {
+        console.warn(`Attempting batch update with ${requests.length} requests, exceeding typical limits. May fail.`);
+    }
+    try {
+        const response = await docs.documents.batchUpdate({
+            documentId: documentId,
+            requestBody: { requests },
+        });
+        return response.data;
+    }
+    catch (error) {
+        console.error(`Google API batchUpdate Error for doc ${documentId}:`, error.response?.data || error.message);
+        // Translate common API errors to UserErrors
+        if (error.code === 400 && error.message.includes('Invalid requests')) {
+            // Try to extract more specific info if available
+            const details = error.response?.data?.error?.details;
+            let detailMsg = '';
+            if (details && Array.isArray(details)) {
+                detailMsg = details.map(d => d.description || JSON.stringify(d)).join('; ');
+            }
+            throw new UserError(`Invalid request sent to Google Docs API. Details: ${detailMsg || error.message}`);
+        }
+        if (error.code === 404)
+            throw new UserError(`Document not found (ID: ${documentId}). Check the ID.`);
+        if (error.code === 403)
+            throw new UserError(`Permission denied for document (ID: ${documentId}). Ensure the authenticated user has edit access.`);
+        // Generic internal error for others
+        throw new Error(`Google API Error (${error.code}): ${error.message}`);
+    }
+}
+// --- Text Finding Helper ---
+// This improved version is more robust in handling various text structure scenarios
+export async function findTextRange(docs, documentId, textToFind, instance = 1) {
+    try {
+        // Request more detailed information about the document structure
+        const res = await docs.documents.get({
+            documentId,
+            // Request more fields to handle various container types (not just paragraphs)
+            fields: 'body(content(paragraph(elements(startIndex,endIndex,textRun(content))),table,sectionBreak,tableOfContents,startIndex,endIndex))',
+        });
+        if (!res.data.body?.content) {
+            console.warn(`No content found in document ${documentId}`);
+            return null;
+        }
+        // More robust text collection and index tracking
+        let fullText = '';
+        const segments = [];
+        // Process all content elements, including structural ones
+        const collectTextFromContent = (content) => {
+            content.forEach(element => {
+                // Handle paragraph elements
+                if (element.paragraph?.elements) {
+                    element.paragraph.elements.forEach((pe) => {
+                        if (pe.textRun?.content && pe.startIndex !== undefined && pe.endIndex !== undefined) {
+                            const content = pe.textRun.content;
+                            fullText += content;
+                            segments.push({
+                                text: content,
+                                start: pe.startIndex,
+                                end: pe.endIndex
+                            });
+                        }
+                    });
+                }
+                // Handle table elements - this is simplified and might need expansion
+                if (element.table && element.table.tableRows) {
+                    element.table.tableRows.forEach((row) => {
+                        if (row.tableCells) {
+                            row.tableCells.forEach((cell) => {
+                                if (cell.content) {
+                                    collectTextFromContent(cell.content);
+                                }
+                            });
+                        }
+                    });
+                }
+                // Add handling for other structural elements as needed
+            });
+        };
+        collectTextFromContent(res.data.body.content);
+        // Sort segments by starting position to ensure correct ordering
+        segments.sort((a, b) => a.start - b.start);
+        console.log(`Document ${documentId} contains ${segments.length} text segments and ${fullText.length} characters in total.`);
+        // Find the specified instance of the text
+        let startIndex = -1;
+        let endIndex = -1;
+        let foundCount = 0;
+        let searchStartIndex = 0;
+        while (foundCount < instance) {
+            const currentIndex = fullText.indexOf(textToFind, searchStartIndex);
+            if (currentIndex === -1) {
+                console.log(`Search text "${textToFind}" not found for instance ${foundCount + 1} (requested: ${instance})`);
+                break;
+            }
+            foundCount++;
+            console.log(`Found instance ${foundCount} of "${textToFind}" at position ${currentIndex} in full text`);
+            if (foundCount === instance) {
+                const targetStartInFullText = currentIndex;
+                const targetEndInFullText = currentIndex + textToFind.length;
+                let currentPosInFullText = 0;
+                console.log(`Target text range in full text: ${targetStartInFullText}-${targetEndInFullText}`);
+                for (const seg of segments) {
+                    const segStartInFullText = currentPosInFullText;
+                    const segTextLength = seg.text.length;
+                    const segEndInFullText = segStartInFullText + segTextLength;
+                    // Map from reconstructed text position to actual document indices
+                    if (startIndex === -1 && targetStartInFullText >= segStartInFullText && targetStartInFullText < segEndInFullText) {
+                        startIndex = seg.start + (targetStartInFullText - segStartInFullText);
+                        console.log(`Mapped start to segment ${seg.start}-${seg.end}, position ${startIndex}`);
+                    }
+                    if (targetEndInFullText > segStartInFullText && targetEndInFullText <= segEndInFullText) {
+                        endIndex = seg.start + (targetEndInFullText - segStartInFullText);
+                        console.log(`Mapped end to segment ${seg.start}-${seg.end}, position ${endIndex}`);
+                        break;
+                    }
+                    currentPosInFullText = segEndInFullText;
+                }
+                if (startIndex === -1 || endIndex === -1) {
+                    console.warn(`Failed to map text "${textToFind}" instance ${instance} to actual document indices`);
+                    // Reset and try next occurrence
+                    startIndex = -1;
+                    endIndex = -1;
+                    searchStartIndex = currentIndex + 1;
+                    foundCount--;
+                    continue;
+                }
+                console.log(`Successfully mapped "${textToFind}" to document range ${startIndex}-${endIndex}`);
+                return { startIndex, endIndex };
+            }
+            // Prepare for next search iteration
+            searchStartIndex = currentIndex + 1;
+        }
+        console.warn(`Could not find instance ${instance} of text "${textToFind}" in document ${documentId}`);
+        return null; // Instance not found or mapping failed for all attempts
+    }
+    catch (error) {
+        console.error(`Error finding text "${textToFind}" in doc ${documentId}: ${error.message || 'Unknown error'}`);
+        if (error.code === 404)
+            throw new UserError(`Document not found while searching text (ID: ${documentId}).`);
+        if (error.code === 403)
+            throw new UserError(`Permission denied while searching text in doc ${documentId}.`);
+        throw new Error(`Failed to retrieve doc for text searching: ${error.message || 'Unknown error'}`);
+    }
+}
+// --- Paragraph Boundary Helper ---
+// Enhanced version to handle document structural elements more robustly
+export async function getParagraphRange(docs, documentId, indexWithin) {
+    try {
+        console.log(`Finding paragraph containing index ${indexWithin} in document ${documentId}`);
+        // Request more detailed document structure to handle nested elements
+        const res = await docs.documents.get({
+            documentId,
+            // Request more comprehensive structure information
+            fields: 'body(content(startIndex,endIndex,paragraph,table,sectionBreak,tableOfContents))',
+        });
+        if (!res.data.body?.content) {
+            console.warn(`No content found in document ${documentId}`);
+            return null;
+        }
+        // Find paragraph containing the index
+        // We'll look at all structural elements recursively
+        const findParagraphInContent = (content) => {
+            for (const element of content) {
+                // Check if we have element boundaries defined
+                if (element.startIndex !== undefined && element.endIndex !== undefined) {
+                    // Check if index is within this element's range first
+                    if (indexWithin >= element.startIndex && indexWithin < element.endIndex) {
+                        // If it's a paragraph, we've found our target
+                        if (element.paragraph) {
+                            console.log(`Found paragraph containing index ${indexWithin}, range: ${element.startIndex}-${element.endIndex}`);
+                            return {
+                                startIndex: element.startIndex,
+                                endIndex: element.endIndex
+                            };
+                        }
+                        // If it's a table, we need to check cells recursively
+                        if (element.table && element.table.tableRows) {
+                            console.log(`Index ${indexWithin} is within a table, searching cells...`);
+                            for (const row of element.table.tableRows) {
+                                if (row.tableCells) {
+                                    for (const cell of row.tableCells) {
+                                        if (cell.content) {
+                                            const result = findParagraphInContent(cell.content);
+                                            if (result)
+                                                return result;
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                        // For other structural elements, we didn't find a paragraph
+                        // but we know the index is within this element
+                        console.warn(`Index ${indexWithin} is within element (${element.startIndex}-${element.endIndex}) but not in a paragraph`);
+                    }
+                }
+            }
+            return null;
+        };
+        const paragraphRange = findParagraphInContent(res.data.body.content);
+        if (!paragraphRange) {
+            console.warn(`Could not find paragraph containing index ${indexWithin}`);
+        }
+        else {
+            console.log(`Returning paragraph range: ${paragraphRange.startIndex}-${paragraphRange.endIndex}`);
+        }
+        return paragraphRange;
+    }
+    catch (error) {
+        console.error(`Error getting paragraph range for index ${indexWithin} in doc ${documentId}: ${error.message || 'Unknown error'}`);
+        if (error.code === 404)
+            throw new UserError(`Document not found while finding paragraph (ID: ${documentId}).`);
+        if (error.code === 403)
+            throw new UserError(`Permission denied while accessing doc ${documentId}.`);
+        throw new Error(`Failed to find paragraph: ${error.message || 'Unknown error'}`);
+    }
+}
+// --- Style Request Builders ---
+export function buildUpdateTextStyleRequest(startIndex, endIndex, style) {
+    const textStyle = {};
+    const fieldsToUpdate = [];
+    if (style.bold !== undefined) {
+        textStyle.bold = style.bold;
+        fieldsToUpdate.push('bold');
+    }
+    if (style.italic !== undefined) {
+        textStyle.italic = style.italic;
+        fieldsToUpdate.push('italic');
+    }
+    if (style.underline !== undefined) {
+        textStyle.underline = style.underline;
+        fieldsToUpdate.push('underline');
+    }
+    if (style.strikethrough !== undefined) {
+        textStyle.strikethrough = style.strikethrough;
+        fieldsToUpdate.push('strikethrough');
+    }
+    if (style.fontSize !== undefined) {
+        textStyle.fontSize = { magnitude: style.fontSize, unit: 'PT' };
+        fieldsToUpdate.push('fontSize');
+    }
+    if (style.fontFamily !== undefined) {
+        textStyle.weightedFontFamily = { fontFamily: style.fontFamily };
+        fieldsToUpdate.push('weightedFontFamily');
+    }
+    if (style.foregroundColor !== undefined) {
+        const rgbColor = hexToRgbColor(style.foregroundColor);
+        if (!rgbColor)
+            throw new UserError(`Invalid foreground hex color format: ${style.foregroundColor}`);
+        textStyle.foregroundColor = { color: { rgbColor: rgbColor } };
+        fieldsToUpdate.push('foregroundColor');
+    }
+    if (style.backgroundColor !== undefined) {
+        const rgbColor = hexToRgbColor(style.backgroundColor);
+        if (!rgbColor)
+            throw new UserError(`Invalid background hex color format: ${style.backgroundColor}`);
+        textStyle.backgroundColor = { color: { rgbColor: rgbColor } };
+        fieldsToUpdate.push('backgroundColor');
+    }
+    if (style.linkUrl !== undefined) {
+        textStyle.link = { url: style.linkUrl };
+        fieldsToUpdate.push('link');
+    }
+    // TODO: Handle clearing formatting
+    if (fieldsToUpdate.length === 0)
+        return null; // No styles to apply
+    const request = {
+        updateTextStyle: {
+            range: { startIndex, endIndex },
+            textStyle: textStyle,
+            fields: fieldsToUpdate.join(','),
+        }
+    };
+    return { request, fields: fieldsToUpdate };
+}
+export function buildUpdateParagraphStyleRequest(startIndex, endIndex, style) {
+    // Create style object and track which fields to update
+    const paragraphStyle = {};
+    const fieldsToUpdate = [];
+    console.log(`Building paragraph style request for range ${startIndex}-${endIndex} with options:`, style);
+    // Process alignment option (LEFT, CENTER, RIGHT, JUSTIFIED)
+    if (style.alignment !== undefined) {
+        paragraphStyle.alignment = style.alignment;
+        fieldsToUpdate.push('alignment');
+        console.log(`Setting alignment to ${style.alignment}`);
+    }
+    // Process indentation options
+    if (style.indentStart !== undefined) {
+        paragraphStyle.indentStart = { magnitude: style.indentStart, unit: 'PT' };
+        fieldsToUpdate.push('indentStart');
+        console.log(`Setting left indent to ${style.indentStart}pt`);
+    }
+    if (style.indentEnd !== undefined) {
+        paragraphStyle.indentEnd = { magnitude: style.indentEnd, unit: 'PT' };
+        fieldsToUpdate.push('indentEnd');
+        console.log(`Setting right indent to ${style.indentEnd}pt`);
+    }
+    // Process spacing options
+    if (style.spaceAbove !== undefined) {
+        paragraphStyle.spaceAbove = { magnitude: style.spaceAbove, unit: 'PT' };
+        fieldsToUpdate.push('spaceAbove');
+        console.log(`Setting space above to ${style.spaceAbove}pt`);
+    }
+    if (style.spaceBelow !== undefined) {
+        paragraphStyle.spaceBelow = { magnitude: style.spaceBelow, unit: 'PT' };
+        fieldsToUpdate.push('spaceBelow');
+        console.log(`Setting space below to ${style.spaceBelow}pt`);
+    }
+    // Process named style types (headings, etc.)
+    if (style.namedStyleType !== undefined) {
+        paragraphStyle.namedStyleType = style.namedStyleType;
+        fieldsToUpdate.push('namedStyleType');
+        console.log(`Setting named style to ${style.namedStyleType}`);
+    }
+    // Process page break control
+    if (style.keepWithNext !== undefined) {
+        paragraphStyle.keepWithNext = style.keepWithNext;
+        fieldsToUpdate.push('keepWithNext');
+        console.log(`Setting keepWithNext to ${style.keepWithNext}`);
+    }
+    // Verify we have styles to apply
+    if (fieldsToUpdate.length === 0) {
+        console.warn("No paragraph styling options were provided");
+        return null; // No styles to apply
+    }
+    // Build the request object
+    const request = {
+        updateParagraphStyle: {
+            range: { startIndex, endIndex },
+            paragraphStyle: paragraphStyle,
+            fields: fieldsToUpdate.join(','),
+        }
+    };
+    console.log(`Created paragraph style request with fields: ${fieldsToUpdate.join(', ')}`);
+    return { request, fields: fieldsToUpdate };
+}
+// --- Specific Feature Helpers ---
+export async function createTable(docs, documentId, rows, columns, index) {
+    if (rows < 1 || columns < 1) {
+        throw new UserError("Table must have at least 1 row and 1 column.");
+    }
+    const request = {
+        insertTable: {
+            location: { index },
+            rows: rows,
+            columns: columns,
+        }
+    };
+    return executeBatchUpdate(docs, documentId, [request]);
+}
+export async function insertText(docs, documentId, text, index) {
+    if (!text)
+        return {}; // Nothing to insert
+    const request = {
+        insertText: {
+            location: { index },
+            text: text,
+        }
+    };
+    return executeBatchUpdate(docs, documentId, [request]);
+}
+// --- Complex / Stubbed Helpers ---
+export async function findParagraphsMatchingStyle(docs, documentId, styleCriteria // Define a proper type for criteria (e.g., { fontFamily: 'Arial', bold: true })
+) {
+    // TODO: Implement logic
+    // 1. Get document content with paragraph elements and their styles.
+    // 2. Iterate through paragraphs.
+    // 3. For each paragraph, check if its computed style matches the criteria.
+    // 4. Return ranges of matching paragraphs.
+    console.warn("findParagraphsMatchingStyle is not implemented.");
+    throw new NotImplementedError("Finding paragraphs by style criteria is not yet implemented.");
+    // return [];
+}
+export async function detectAndFormatLists(docs, documentId, startIndex, endIndex) {
+    // TODO: Implement complex logic
+    // 1. Get document content (paragraphs, text runs) in the specified range (or whole doc).
+    // 2. Iterate through paragraphs.
+    // 3. Identify sequences of paragraphs starting with list-like markers (e.g., "-", "*", "1.", "a)").
+    // 4. Determine nesting levels based on indentation or marker patterns.
+    // 5. Generate CreateParagraphBulletsRequests for the identified sequences.
+    // 6. Potentially delete the original marker text.
+    // 7. Execute the batch update.
+    console.warn("detectAndFormatLists is not implemented.");
+    throw new NotImplementedError("Automatic list detection and formatting is not yet implemented.");
+    // return {};
+}
+export async function addCommentHelper(docs, documentId, text, startIndex, endIndex) {
+    // NOTE: Adding comments typically requires the Google Drive API v3 and different scopes!
+    // 'https://www.googleapis.com/auth/drive' or more specific comment scopes.
+    // This helper is a placeholder assuming Drive API client (`drive`) is available and authorized.
+    /*
+    const drive = google.drive({version: 'v3', auth: authClient}); // Assuming authClient is available
+    await drive.comments.create({
+    fileId: documentId,
+    requestBody: {
+    content: text,
+    anchor: JSON.stringify({ // Anchor format might need verification
+    'type': 'workbook#textAnchor', // Or appropriate type for Docs
+    'refs': [{
+    'docRevisionId': 'head', // Or specific revision
+    'range': {
+    'start': startIndex,
+    'end': endIndex,
+    }
+    }]
+    })
+    },
+    fields: 'id'
+    });
+    */
+    console.warn("addCommentHelper requires Google Drive API and is not implemented.");
+    throw new NotImplementedError("Adding comments requires Drive API setup and is not yet implemented.");
+}
+// --- Image Insertion Helpers ---
+/**
+ * Inserts an inline image into a document from a publicly accessible URL
+ * @param docs - Google Docs API client
+ * @param documentId - The document ID
+ * @param imageUrl - Publicly accessible URL to the image
+ * @param index - Position in the document where image should be inserted (1-based)
+ * @param width - Optional width in points
+ * @param height - Optional height in points
+ * @returns Promise with batch update response
+ */
+export async function insertInlineImage(docs, documentId, imageUrl, index, width, height) {
+    // Validate URL format
+    try {
+        new URL(imageUrl);
+    }
+    catch (e) {
+        throw new UserError(`Invalid image URL format: ${imageUrl}`);
+    }
+    // Build the insertInlineImage request
+    const request = {
+        insertInlineImage: {
+            location: { index },
+            uri: imageUrl,
+            ...(width && height && {
+                objectSize: {
+                    height: { magnitude: height, unit: 'PT' },
+                    width: { magnitude: width, unit: 'PT' }
+                }
+            })
+        }
+    };
+    return executeBatchUpdate(docs, documentId, [request]);
+}
+/**
+ * Uploads a local image file to Google Drive and returns its public URL
+ * @param drive - Google Drive API client
+ * @param localFilePath - Path to the local image file
+ * @param parentFolderId - Optional parent folder ID (defaults to root)
+ * @returns Promise with the public webContentLink URL
+ */
+export async function uploadImageToDrive(drive, // drive_v3.Drive type
+localFilePath, parentFolderId) {
+    const fs = await import('fs');
+    const path = await import('path');
+    // Verify file exists
+    if (!fs.existsSync(localFilePath)) {
+        throw new UserError(`Image file not found: ${localFilePath}`);
+    }
+    // Get file name and mime type
+    const fileName = path.basename(localFilePath);
+    const mimeTypeMap = {
+        '.jpg': 'image/jpeg',
+        '.jpeg': 'image/jpeg',
+        '.png': 'image/png',
+        '.gif': 'image/gif',
+        '.bmp': 'image/bmp',
+        '.webp': 'image/webp',
+        '.svg': 'image/svg+xml'
+    };
+    const ext = path.extname(localFilePath).toLowerCase();
+    const mimeType = mimeTypeMap[ext] || 'application/octet-stream';
+    // Upload file to Drive
+    const fileMetadata = {
+        name: fileName,
+        mimeType: mimeType
+    };
+    if (parentFolderId) {
+        fileMetadata.parents = [parentFolderId];
+    }
+    const media = {
+        mimeType: mimeType,
+        body: fs.createReadStream(localFilePath)
+    };
+    const uploadResponse = await drive.files.create({
+        requestBody: fileMetadata,
+        media: media,
+        fields: 'id,webViewLink,webContentLink'
+    });
+    const fileId = uploadResponse.data.id;
+    if (!fileId) {
+        throw new Error('Failed to upload image to Drive - no file ID returned');
+    }
+    // Make the file publicly readable
+    await drive.permissions.create({
+        fileId: fileId,
+        supportsAllDrives: true,
+        requestBody: {
+            role: 'reader',
+            type: 'anyone'
+        }
+    });
+    // Get the webContentLink
+    const fileInfo = await drive.files.get({
+        fileId: fileId,
+        fields: 'webContentLink'
+    });
+    const webContentLink = fileInfo.data.webContentLink;
+    if (!webContentLink) {
+        throw new Error('Failed to get public URL for uploaded image');
+    }
+    return webContentLink;
+}
+/**
+ * Recursively collect all tabs from a document in a flat list with hierarchy info
+ * @param doc - The Google Doc document object
+ * @returns Array of tabs with nesting level information
+ */
+export function getAllTabs(doc) {
+    const allTabs = [];
+    if (!doc.tabs || doc.tabs.length === 0) {
+        return allTabs;
+    }
+    for (const tab of doc.tabs) {
+        addCurrentAndChildTabs(tab, allTabs, 0);
+    }
+    return allTabs;
+}
+/**
+ * Recursive helper to add tabs with their nesting level
+ * @param tab - The tab to add
+ * @param allTabs - The accumulator array
+ * @param level - Current nesting level (0 for top-level)
+ */
+function addCurrentAndChildTabs(tab, allTabs, level) {
+    allTabs.push({ ...tab, level });
+    if (tab.childTabs && tab.childTabs.length > 0) {
+        for (const childTab of tab.childTabs) {
+            addCurrentAndChildTabs(childTab, allTabs, level + 1);
+        }
+    }
+}
+/**
+ * Get the text length from a DocumentTab
+ * @param documentTab - The DocumentTab object
+ * @returns Total character count
+ */
+export function getTabTextLength(documentTab) {
+    let totalLength = 0;
+    if (!documentTab?.body?.content) {
+        return 0;
+    }
+    documentTab.body.content.forEach((element) => {
+        // Handle paragraphs
+        if (element.paragraph?.elements) {
+            element.paragraph.elements.forEach((pe) => {
+                if (pe.textRun?.content) {
+                    totalLength += pe.textRun.content.length;
+                }
+            });
+        }
+        // Handle tables
+        if (element.table?.tableRows) {
+            element.table.tableRows.forEach((row) => {
+                row.tableCells?.forEach((cell) => {
+                    cell.content?.forEach((cellElement) => {
+                        cellElement.paragraph?.elements?.forEach((pe) => {
+                            if (pe.textRun?.content) {
+                                totalLength += pe.textRun.content.length;
+                            }
+                        });
+                    });
+                });
+            });
+        }
+    });
+    return totalLength;
+}
+/**
+ * Find a specific tab by ID in a document (searches recursively through child tabs)
+ * @param doc - The Google Doc document object
+ * @param tabId - The tab ID to search for
+ * @returns The tab object if found, null otherwise
+ */
+export function findTabById(doc, tabId) {
+    if (!doc.tabs || doc.tabs.length === 0) {
+        return null;
+    }
+    // Helper function to search through tabs recursively
+    const searchTabs = (tabs) => {
+        for (const tab of tabs) {
+            if (tab.tabProperties?.tabId === tabId) {
+                return tab;
+            }
+            // Recursively search child tabs
+            if (tab.childTabs && tab.childTabs.length > 0) {
+                const found = searchTabs(tab.childTabs);
+                if (found)
+                    return found;
+            }
+        }
+        return null;
+    };
+    return searchTabs(doc.tabs);
+}