@aws/lsp-codewhisperer 0.0.63 → 0.0.65

package/out/language-server/agenticChat/tools/qCodeAnalysis/qCodeReview.d.ts

@@ -0,0 +1,211 @@
+import { Features } from '@aws/language-server-runtimes/server-interface/server';
+import { InvokeOutput } from '../toolShared';
+export declare class QCodeReview {
+    private static readonly CUSTOMER_CODE_BASE_PATH;
+    private static readonly CODE_ARTIFACT_PATH;
+    private static readonly CUSTOMER_CODE_ZIP_NAME;
+    private static readonly CODE_DIFF_PATH;
+    private static readonly RULE_ARTIFACT_PATH;
+    private static readonly MAX_POLLING_ATTEMPTS;
+    private static readonly MID_POLLING_ATTEMPTS;
+    private static readonly POLLING_INTERVAL_MS;
+    private static readonly UPLOAD_INTENT;
+    private static readonly SCAN_SCOPE;
+    private static readonly MAX_FINDINGS_COUNT;
+    private static readonly ERROR_MESSAGES;
+    private readonly credentialsProvider;
+    private readonly logging;
+    private readonly telemetry;
+    private readonly workspace;
+    private codeWhispererClient?;
+    private cancellationToken?;
+    private writableStream?;
+    constructor(features: Pick<Features, 'credentialsProvider' | 'logging' | 'telemetry' | 'workspace'> & Partial<Features>);
+    static readonly toolName = "qCodeReview";
+    static readonly toolDescription: string;
+    static readonly inputSchema: {
+        type: "object";
+        description: string;
+        properties: {
+            scopeOfReview: {
+                type: "string";
+                description: string;
+                enum: string[];
+            };
+            fileLevelArtifacts: {
+                type: "array";
+                description: string;
+                items: {
+                    type: "object";
+                    description: string;
+                    properties: {
+                        path: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: readonly ["path"];
+                };
+            };
+            folderLevelArtifacts: {
+                type: "array";
+                description: string;
+                items: {
+                    type: "object";
+                    description: string;
+                    properties: {
+                        path: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: readonly ["path"];
+                };
+            };
+        };
+        required: readonly ["scopeOfReview"];
+    };
+    /**
+     * Main execution method for the QCodeReview tool
+     * @param input User input parameters for code review
+     * @param context Execution context containing clients and tokens
+     * @returns Output containing code review results or error message
+     */
+    execute(input: any, context: any): Promise<InvokeOutput>;
+    /**
+     * Validates user input and sets up the execution environment
+     * @param input User input parameters for code review
+     * @param context Execution context containing clients and tokens
+     * @returns Setup object with validated parameters or error message
+     */
+    private validateInputAndSetup;
+    /**
+     * Prepares and uploads code artifacts for analysis
+     * @param setup Setup object with validated parameters
+     * @returns Upload result with uploadId or error message
+     */
+    private prepareAndUploadArtifacts;
+    /**
+     * Initiates code analysis with the uploaded artifacts
+     * @param setup Setup object with validated parameters
+     * @param uploadResult Result from artifact upload containing uploadId
+     * @returns Code scan jobId and status
+     */
+    private startCodeAnalysis;
+    /**
+     * Polls for completion of the code analysis job
+     * @param jobId ID of the code analysis job
+     * @param scanName Name of the code scan
+     * @param artifactType Type of artifact being scanned (FILE or FOLDER)
+     * @param chatStreamWriter Stream writer for sending progress updates
+     */
+    private pollForCompletion;
+    /**
+     * Processes the results of the completed code analysis
+     * @param setup Setup object with validated parameters
+     * @param isCodeDiffPresent If code diff is present in upload artifact
+     * @param jobId ID of the code analysis job
+     * @returns Processed results with findings grouped by file
+     */
+    private processResults;
+    /**
+     * Collects findings from the code analysis job
+     * @param jobId ID of the code analysis job
+     * @param isFullReviewRequest Whether this is a full review or diff review
+     * @param isCodeDiffPresent Whether code diff is present in the artifacts
+     * @param programmingLanguage Programming language
+     * @returns Object containing collected findings and whether limit was exceeded
+     */
+    private collectFindings;
+    /**
+     * Gets the current status of a code analysis job
+     * @param jobId ID of the code analysis job
+     * @returns Status response from the CodeWhisperer service
+     */
+    private getCodeAnalysisStatus;
+    /**
+     * Retrieves findings from a code analysis job
+     * @param jobId ID of the code analysis job
+     * @param nextToken Pagination token for retrieving next batch of findings
+     * @returns Findings response from the CodeWhisperer service
+     */
+    private getCodeAnalysisFindings;
+    /**
+     * Create a zip archive of the files and folders to be scanned and calculate MD5 hash
+     * @param fileArtifacts Array of file artifacts containing path and programming language
+     * @param folderArtifacts Array of folder artifacts containing path
+     * @param ruleArtifacts Array of file paths to user selected rules
+     * @param isFullReviewRequest If user asked for Full review or Partial review
+     * @returns An object containing the zip file buffer and its MD5 hash
+     */
+    private prepareFilesAndFoldersForUpload;
+    /**
+     * Processes file, folder, and rule artifacts for inclusion in the zip archive
+     * @param fileArtifacts Array of file artifacts to process
+     * @param folderArtifacts Array of folder artifacts to process
+     * @param ruleArtifacts Array of rule artifacts to process
+     * @param customerCodeZip JSZip instance for the customer code
+     * @param isCodeDiffScan Whether this is a code diff scan
+     * @returns Combined code diff string from all artifacts
+     */
+    private processArtifacts;
+    /**
+     * Processes file artifacts for inclusion in the zip archive
+     * @param fileArtifacts Array of file artifacts to process
+     * @param customerCodeZip JSZip instance for the customer code
+     * @param isCodeDiffScan Whether this is a code diff scan
+     * @returns Combined code diff string from file artifacts
+     */
+    private processFileArtifacts;
+    /**
+     * Processes folder artifacts for inclusion in the zip archive
+     * @param folderArtifacts Array of folder artifacts to process
+     * @param customerCodeZip JSZip instance for the customer code
+     * @param isCodeDiffScan Whether this is a code diff scan
+     * @returns Combined code diff string from folder artifacts
+     */
+    private processFolderArtifacts;
+    /**
+     * Processes rule artifacts for inclusion in the zip archive
+     * @param ruleArtifacts Array of rule artifacts to process
+     * @param customerCodeZip JSZip instance for the customer code
+     */
+    private processRuleArtifacts;
+    /**
+     * Recursively add a folder and its contents to a zip archive
+     * @param zip JSZip instance to add files to
+     * @param folderPath Path to the folder to add
+     * @param zipPath Relative path within the zip archive
+     */
+    private addFolderToZip;
+    /**
+     * Parse and validate findings JSON response
+     * @param findingsJson Raw JSON string from the code analysis response
+     * @param jobId Code scan job Id
+     * @param programmingLanguage programming language
+     * @returns Parsed and validated findings array
+     */
+    private parseFindings;
+    /**
+     * Aggregate findings by file path
+     * @param findings Array of findings
+     * @param fileArtifacts Array of file artifacts being scanned
+     * @param folderArtifacts Array of folder artifacts being scanned
+     * @returns Array of findings grouped by resolved file path
+     */
+    private aggregateFindingsByFile;
+    /**
+     * Resolve finding file path to actual file path
+     * @param findingPath Relative file path from the finding
+     * @param fileArtifacts Array of file artifacts being scanned
+     * @param folderArtifacts Array of folder artifacts being scanned
+     * @returns Resolved absolute file path or null if not found
+     */
+    private resolveFilePath;
+    /**
+     * Checks if the operation has been cancelled by the user
+     * @param message Optional message to include in the cancellation error
+     * @throws Error if the operation has been cancelled
+     */
+    private checkCancellation;
+}