lokalise-mcp
Version:
The Lokalise MCP Server brings Lokalise's localization power to Claude and AI assistants—manage projects, keys, and translations by chat.
72 lines (71 loc) • 3.71 kB
TypeScript
import type { BulkResult, CursorPaginatedResult, Key, KeyDeleted, KeysBulkDeleted } from "@lokalise/node-api";
/**
* @namespace KeysFormatter
* @description Utility functions for formatting Lokalise Keys API responses into readable formats.
* Provides consistent Markdown formatting for various key operations.
*/
/**
* @function formatKeysList
* @description Formats a list of keys into a comprehensive, LLM-friendly Markdown report
* @memberof KeysFormatter
* @param {any} response - The raw response from the Lokalise Keys API list operation
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the keys list
*/
export declare function formatKeysList(response: CursorPaginatedResult<Key>, projectId: string): string;
/**
* @function formatKeyDetails
* @description Formats detailed information about a single key with comprehensive LLM-friendly output
* @memberof KeysFormatter
* @param {Key} key - The key object from Lokalise API
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the key details
*/
export declare function formatKeyDetails(key: Key, projectId: string): string;
/**
* @function formatCreateKeysResult
* @description Formats the result of a bulk key creation operation
* @memberof KeysFormatter
* @param {any} response - The raw response from the Lokalise Keys API create operation
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the creation results
*/
export declare function formatCreateKeysResult(response: BulkResult<Key>, projectId: string): string;
/**
* @function formatUpdateKeyResult
* @description Formats the result of a key update operation
* @memberof KeysFormatter
* @param {Key} key - The updated key object from Lokalise API
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the update results
*/
export declare function formatUpdateKeyResult(key: Key, projectId: string): string;
/**
* @function formatDeleteKeyResult
* @description Formats the result of a key deletion operation
* @memberof KeysFormatter
* @param {any} response - The raw response from the Lokalise Keys API delete operation
* @param {string} projectId - The project ID for context
* @param {number} keyId - The deleted key ID
* @returns {string} Formatted Markdown string containing the deletion confirmation
*/
export declare function formatDeleteKeyResult(response: KeyDeleted, projectId: string, keyId: number): string;
/**
* @function formatBulkUpdateKeysResult
* @description Formats the result of a bulk key update operation
* @memberof KeysFormatter
* @param {any} response - The raw response from the Lokalise Keys API bulk update operation
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the bulk update results
*/
export declare function formatBulkUpdateKeysResult(response: BulkResult<Key>, projectId: string): string;
/**
* @function formatBulkDeleteKeysResult
* @description Formats the result of a bulk key deletion operation
* @memberof KeysFormatter
* @param {any} response - The raw response from the Lokalise Keys API bulk delete operation
* @param {string} projectId - The project ID for context
* @param {number} requestedCount - The number of keys requested to be deleted
* @returns {string} Formatted Markdown string containing the bulk deletion results
*/
export declare function formatBulkDeleteKeysResult(response: KeysBulkDeleted, projectId: string, requestedCount: number): string;