ds-sfcoe-ailabs/lib/common/utils/docuSignRuleUtils.d.ts

AI-powered code review tool with static analysis integration for comprehensive code quality assessment.

import type { DocuSignIssue, TableEntry } from './index.js';
/**
 * Utility class for Docusign-specific code analysis rules
 *
 * Provides specialized rule checking for DocuSign's coding standards
 * including test framework validation, performance patterns, and
 * transaction logging requirements.
 *
 * @example
 * ```typescript
 * const issues = DocuSignRuleUtils.getDocuSignIssuesForFile(
 *   'MyClass.cls',
 *   'public class MyClass { ... }',
 *   true
 * );
 * console.log(issues.length); // Number of DocuSign-specific issues found
 * ```
 */
export declare class DocuSignRuleUtils {
    /**
     * Check if file uses old test framework
     *
     * @param content - The file content to analyze
     * @returns True if the file uses old test framework patterns
     * @example
     * ```typescript
     * const hasOldFramework = DocuSignRuleUtils.hasOldTestFramework(apexContent);
     * if (hasOldFramework) {
     *   console.log('File uses deprecated test framework');
     * }
     * ```
     */
    static hasOldTestFramework(content: string): boolean;
    /**
     * Check if file uses Schema.getGlobalDescribe()
     *
     * @param content - The file content to analyze
     * @returns Array of Docusign issues found related to Schema.getGlobalDescribe() usage
     * @example
     * ```typescript
     * const issues = DocuSignRuleUtils.hasGlobalDescribeUsage(apexContent);
     * issues.forEach(issue => {
     *   console.log(`Line ${issue.lineNumber}: ${issue.issue}`);
     * });
     * ```
     */
    static hasGlobalDescribeUsage(content: string): DocuSignIssue[];
    /**
     * Check if an Apex class references TransactionLogger
     *
     * @param content - The file content to analyze
     * @returns True if the content references TransactionLogger
     * @example
     * ```typescript
     * const hasLogger = DocuSignRuleUtils.hasTransactionLoggerReference(apexContent);
     * if (!hasLogger) {
     *   console.log('TransactionLogger reference missing');
     * }
     * ```
     */
    static hasTransactionLoggerReference(content: string): boolean;
    /**
     * Check if an Apex class is a new file and missing TransactionLogger reference
     *
     * @param filePath - The path of the file being analyzed
     * @param content - The content of the file to analyze
     * @param isNewFile - Whether this is a new file (added in commit)
     * @returns Array of Docusign issues if TransactionLogger is missing from new Apex class
     * @example
     * ```typescript
     * const issues = DocuSignRuleUtils.checkTransactionLoggerInNewApexClass(
     *   'MyController.cls',
     *   apexContent,
     *   true
     * );
     * if (issues.length > 0) {
     *   console.log('New Apex class missing TransactionLogger');
     * }
     * ```
     */
    static checkTransactionLoggerInNewApexClass(filePath: string, content: string, isNewFile: boolean): DocuSignIssue[];
    /**
     * Get Docusign issues for a specific file
     *
     * @param filePath - The path of the file being analyzed
     * @param content - The content of the file to analyze
     * @param isNewFile - Whether this is a new file (optional, defaults to false)
     * @returns Array of Docusign-specific issues found in the file
     * @example
     * ```typescript
     * const issues = DocuSignRuleUtils.getDocuSignIssuesForFile(
     *   'MyClass.cls',
     *   apexContent,
     *   true
     * );
     * console.log(`Found ${issues.length} DocuSign-specific issues`);
     * ```
     */
    static getDocuSignIssuesForFile(filePath: string, content: string, isNewFile?: boolean): DocuSignIssue[];
    /**
     * Create JavaScript-specific table entries for common issues
     *
     * @param fileName - The name of the JavaScript file being analyzed
     * @param content - The content of the file to analyze
     * @param addedEntries - Set of already processed entry keys to avoid duplicates
     * @returns Array of table entries for JavaScript-specific issues found
     * @example
     * ```typescript
     * const entries = DocuSignRuleUtils.createJavaScriptTableEntries(
     *   'app.js',
     *   jsContent,
     *   new Set()
     * );
     * console.log(`Created ${entries.length} table entries`);
     * ```
     */
    static createJavaScriptTableEntries(fileName: string, content: string, addedEntries: Set<string>): TableEntry[];
    /**
     * Extract rule type from hint ruleId
     *
     * @param ruleId - The rule identifier to extract type from
     * @returns The rule type category
     * @example
     * ```typescript
     * const ruleType = DocuSignRuleUtils.extractRuleType('SF_SOQL_IN_LOOP');
     * console.log(ruleType); // 'SOQL_IN_LOOP'
     * ```
     */
    static extractRuleType(ruleId: string): string;
    /**
     * Get suggested fix for JavaScript rules
     *
     * @param ruleId - The rule identifier to get fix for
     * @param message - The rule message for context
     * @returns Suggested fix description for the rule
     * @example
     * ```typescript
     * const fix = DocuSignRuleUtils.getSuggestedFixForJavaScript(
     *   'no-unused-vars',
     *   'Variable is declared but never used'
     * );
     * console.log(fix); // Suggested fix for the rule
     * ```
     */
    static getSuggestedFixForJavaScript(ruleId: string, message: string): string;
}