@aws/lsp-codewhisperer 0.0.64 → 0.0.66

package/out/language-server/agenticChat/tools/qCodeAnalysis/qCodeReviewSchemas.js

@@ -0,0 +1,140 @@
+"use strict";
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Q_FINDINGS_SCHEMA = exports.Q_FINDING_SCHEMA = exports.Z_Q_CODE_REVIEW_INPUT_SCHEMA = exports.Q_CODE_REVIEW_INPUT_SCHEMA = void 0;
+const zod_1 = require("zod");
+const qCodeReviewConstants_1 = require("./qCodeReviewConstants");
+/**
+ * Input schema for QCodeReview tool
+ */
+exports.Q_CODE_REVIEW_INPUT_SCHEMA = {
+    type: 'object',
+    description: [
+        '**3 main fields in the tool:**',
+        '- scopeOfReview: CRITICAL - Must be set to either FULL_REVIEW (analyze entire codebase) or CODE_DIFF_REVIEW (focus only on changes/modifications). This is a required field.',
+        '- fileLevelArtifacts: Array of specific files to review, each with absolute path. Use this when reviewing individual files, not folders. Format: [{"path": "/absolute/path/to/file.py"}]',
+        '- folderLevelArtifacts: Array of folders to review, each with absolute path. Use this when reviewing entire directories, not individual files. Format: [{"path": "/absolute/path/to/folder/"}]',
+        "Note: Either fileLevelArtifacts OR folderLevelArtifacts should be provided based on what's being reviewed, but not both for the same items.",
+    ].join('\n'),
+    properties: {
+        scopeOfReview: {
+            type: 'string',
+            description: [
+                'CRITICAL: You must explicitly set the value of "scopeOfReview" based on user request analysis.',
+                '',
+                'Set "scopeOfReview" to CODE_DIFF_REVIEW when:',
+                '- User explicitly asks to review only changes/modifications/diffs in their code',
+                '- User mentions "review my changes", "look at what I modified", "check the uncommitted changes"',
+                '- User refers to "review the diff", "analyze recent changes", "look at the new code"',
+                '- User mentions "review what I added/updated", "check my latest commits", "review the modified lines"',
+                '- User includes phrases like "new changes", "recent changes", or any combination of words indicating recency (new, latest, recent) with changes/modifications',
+                '- User mentions specific files with terms like "review new changes in [file]" or "check changes in [file]"',
+                '',
+                'Set "scopeOfReview" to FULL_REVIEW for all other cases, including:',
+                '- When user asks for a general code review without mentioning changes/diffs',
+                '- When user asks to review specific files or folders without mentioning changes',
+                '- When user asks for security analysis or best practices review of their code',
+                '',
+                'This is a required field. You must inform the user whether you are performing a full review or only reviewing changes.',
+            ].join('\n'),
+            enum: qCodeReviewConstants_1.SCOPE_OF_CODE_REVIEW,
+        },
+        fileLevelArtifacts: {
+            type: 'array',
+            description: [
+                'Array of absolute file paths that will be reviewed (e.g. [{"path": "absolute/path/to/file.py"}]).',
+                'So, if the user asks for a code review of a single file, provide the absolute file path in the array.',
+                'If the user asks for a code review of multiple files, provide the absolute file paths in the array.',
+                'If the user asks for a code review of a folder, do not provide any file paths or programming languages in this array. It should be provided in folderLevelArtifacts',
+            ].join('\n'),
+            items: {
+                type: 'object',
+                description: 'Array item containing absolute path of artifact (e.g. {"path": "absolute/path/to/file.py"})',
+                properties: {
+                    path: {
+                        type: 'string',
+                        description: 'The absolute path of the file that will be scanned',
+                    },
+                },
+                required: ['path'],
+            },
+        },
+        folderLevelArtifacts: {
+            type: 'array',
+            description: [
+                'Array of absolute folder paths that will be reviewed (e.g. [{"path": "path/to/code/"}]).',
+                'So, if the user asks for a code review of a single folder, provide the absolute folder path in the array.',
+                'If the user asks for a code review of multiple folders, provide multiple absolute folder paths in the array.',
+                'If the user asks for a code review of a file or multiple files, do not provide any folder paths in this array. It should be provided in fileLevelArtifacts.',
+            ].join('\n'),
+            items: {
+                type: 'object',
+                description: 'Array item containing absolute folder path of code that will be scanned (e.g. {"path": "path/to/code/"})',
+                properties: {
+                    path: {
+                        type: 'string',
+                        description: 'The absolute path of the folder that will be scanned',
+                    },
+                },
+                required: ['path'],
+            },
+        },
+    },
+    required: ['scopeOfReview'],
+};
+/**
+ * Zod schema for input validation during execution of Q Code Review tool
+ */
+exports.Z_Q_CODE_REVIEW_INPUT_SCHEMA = zod_1.z.object({
+    scopeOfReview: zod_1.z.enum(qCodeReviewConstants_1.SCOPE_OF_CODE_REVIEW),
+    fileLevelArtifacts: zod_1.z
+        .array(zod_1.z.object({
+        path: zod_1.z.string(),
+    }))
+        .optional(),
+    folderLevelArtifacts: zod_1.z
+        .array(zod_1.z.object({
+        path: zod_1.z.string(),
+    }))
+        .optional(),
+    ruleArtifacts: zod_1.z
+        .array(zod_1.z.object({
+        path: zod_1.z.string(),
+    }))
+        .optional(),
+});
+/**
+ * Schema for a single finding
+ */
+exports.Q_FINDING_SCHEMA = zod_1.z.object({
+    description: zod_1.z.object({
+        markdown: zod_1.z.string(),
+        text: zod_1.z.string(),
+    }),
+    endLine: zod_1.z.number(),
+    filePath: zod_1.z.string(),
+    findingId: zod_1.z.string(),
+    relatedVulnerabilities: zod_1.z.array(zod_1.z.string().optional()),
+    remediation: zod_1.z.object({
+        recommendation: zod_1.z.object({
+            text: zod_1.z.string(),
+            url: zod_1.z.string().nullable().optional(),
+        }),
+    }),
+    severity: zod_1.z.enum(qCodeReviewConstants_1.FINDING_SEVERITY),
+    startLine: zod_1.z.number(),
+    title: zod_1.z.string(),
+    findingContext: zod_1.z.string().nullable().optional(),
+    detectorId: zod_1.z.string().optional(),
+    detectorName: zod_1.z.string().optional(),
+    ruleId: zod_1.z.string().optional(),
+    suggestedFixes: zod_1.z.array(zod_1.z.string().optional()).optional(),
+});
+/**
+ * Schema for an array of findings
+ */
+exports.Q_FINDINGS_SCHEMA = zod_1.z.array(exports.Q_FINDING_SCHEMA);
+//# sourceMappingURL=qCodeReviewSchemas.js.map

package/out/language-server/agenticChat/tools/qCodeAnalysis/qCodeReviewSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qCodeReviewSchemas.js","sourceRoot":"","sources":["../../../../../src/language-server/agenticChat/tools/qCodeAnalysis/qCodeReviewSchemas.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAuB;AACvB,iEAA+E;AAE/E;;GAEG;AACU,QAAA,0BAA0B,GAAG;IACtC,IAAI,EAAS,QAAQ;IACrB,WAAW,EAAE;QACT,gCAAgC;QAChC,8KAA8K;QAC9K,0LAA0L;QAC1L,gMAAgM;QAChM,6IAA6I;KAChJ,CAAC,IAAI,CAAC,IAAI,CAAC;IACZ,UAAU,EAAE;QACR,aAAa,EAAE;YACX,IAAI,EAAS,QAAQ;YACrB,WAAW,EAAE;gBACT,gGAAgG;gBAChG,EAAE;gBACF,+CAA+C;gBAC/C,iFAAiF;gBACjF,iGAAiG;gBACjG,sFAAsF;gBACtF,uGAAuG;gBACvG,+JAA+J;gBAC/J,4GAA4G;gBAC5G,EAAE;gBACF,oEAAoE;gBACpE,6EAA6E;gBAC7E,iFAAiF;gBACjF,+EAA+E;gBAC/E,EAAE;gBACF,wHAAwH;aAC3H,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,2CAAoB;SAC7B;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAS,OAAO;YACpB,WAAW,EAAE;gBACT,mGAAmG;gBACnG,uGAAuG;gBACvG,qGAAqG;gBACrG,qKAAqK;aACxK,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE;gBACH,IAAI,EAAS,QAAQ;gBACrB,WAAW,EACP,6FAA6F;gBACjG,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,IAAI,EAAS,QAAQ;wBACrB,WAAW,EAAE,oDAAoD;qBACpE;iBACJ;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAU;aAC9B;SACJ;QACD,oBAAoB,EAAE;YAClB,IAAI,EAAS,OAAO;YACpB,WAAW,EAAE;gBACT,0FAA0F;gBAC1F,2GAA2G;gBAC3G,8GAA8G;gBAC9G,6JAA6J;aAChK,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE;gBACH,IAAI,EAAS,QAAQ;gBACrB,WAAW,EACP,0GAA0G;gBAC9G,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,IAAI,EAAS,QAAQ;wBACrB,WAAW,EAAE,sDAAsD;qBACtE;iBACJ;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAU;aAC9B;SACJ;KACJ;IACD,QAAQ,EAAE,CAAC,eAAe,CAAU;CACvC,CAAA;AAED;;GAEG;AACU,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IACjD,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,2CAA6C,CAAC;IACpE,kBAAkB,EAAE,OAAC;SAChB,KAAK,CACF,OAAC,CAAC,MAAM,CAAC;QACL,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACnB,CAAC,CACL;SACA,QAAQ,EAAE;IACf,oBAAoB,EAAE,OAAC;SAClB,KAAK,CACF,OAAC,CAAC,MAAM,CAAC;QACL,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACnB,CAAC,CACL;SACA,QAAQ,EAAE;IACf,aAAa,EAAE,OAAC;SACX,KAAK,CACF,OAAC,CAAC,MAAM,CAAC;QACL,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACnB,CAAC,CACL;SACA,QAAQ,EAAE;CAClB,CAAC,CAAA;AAEF;;GAEG;AACU,QAAA,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC;IACrC,WAAW,EAAE,OAAC,CAAC,MAAM,CAAC;QAClB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;QACpB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACnB,CAAC;IACF,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,sBAAsB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC;IACtD,WAAW,EAAE,OAAC,CAAC,MAAM,CAAC;QAClB,cAAc,EAAE,OAAC,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;YAChB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;SACxC,CAAC;KACL,CAAC;IACF,QAAQ,EAAE,OAAC,CAAC,IAAI,CAAC,uCAAyC,CAAC;IAC3D,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAChD,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,cAAc,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC5D,CAAC,CAAA;AAEF;;GAEG;AACU,QAAA,iBAAiB,GAAG,OAAC,CAAC,KAAK,CAAC,wBAAgB,CAAC,CAAA"}

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

@@ -0,0 +1,58 @@
+export type FileArtifacts = Array<{
+    path: string;
+}>;
+export type FolderArtifacts = Array<{
+    path: string;
+}>;
+export type RuleArtifacts = Array<{
+    path: string;
+}>;
+export type ArtifactType = 'FILE' | 'FOLDER';
+export type ValidateInputAndSetupResult = {
+    fileArtifacts: FileArtifacts;
+    folderArtifacts: FolderArtifacts;
+    isFullReviewRequest: boolean;
+    artifactType: ArtifactType;
+    programmingLanguage: string;
+    scanName: string;
+    ruleArtifacts: RuleArtifacts;
+};
+export type PrepareAndUploadArtifactsResult = {
+    uploadId: string;
+    isCodeDiffPresent: boolean;
+};
+export type StartCodeAnalysisResult = {
+    jobId: string;
+    status: string;
+};
+export type CodeReviewResult = {
+    codeReviewId: string;
+    message: string;
+    findingsByFile: string;
+};
+export type QCodeReviewFinding = {
+    filePath: string;
+    startLine: number;
+    endLine: number;
+    comment: string;
+    title: string;
+    description: {
+        markdown: string;
+        text: string;
+    };
+    detectorId?: string;
+    detectorName?: string;
+    findingId: string;
+    ruleId?: string;
+    relatedVulnerabilities: (string | undefined)[];
+    severity: string;
+    suggestedFixes?: (string | undefined)[];
+    recommendation: {
+        text: string;
+        url?: string | null;
+    };
+    scanJobId: string;
+    language: string;
+    autoDetected: false;
+    findingContext: string | null | undefined;
+};

package/out/language-server/agenticChat/tools/qCodeAnalysis/qCodeReviewTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=qCodeReviewTypes.js.map

package/out/language-server/agenticChat/tools/qCodeAnalysis/qCodeReviewTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qCodeReviewTypes.js","sourceRoot":"","sources":["../../../../../src/language-server/agenticChat/tools/qCodeAnalysis/qCodeReviewTypes.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,156 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Features } from '@aws/language-server-runtimes/server-interface/server';
+import JSZip = require('jszip');
+import { InitializeParams } from '@aws/language-server-runtimes/server-interface';
+import { InvokeOutput } from '../toolShared';
+import { CancellationToken } from '@aws/language-server-runtimes/server-interface';
+/**
+ * Utility functions for QCodeReview
+ */
+export declare class QCodeReviewUtils {
+    /**
+     * Check if a file should be skipped during zip creation
+     * @param fileName Name of the file to check
+     * @returns True if the file should be skipped, false otherwise
+     */
+    static shouldSkipFile(fileName: string): boolean;
+    /**
+     * Check if a directory should be skipped during zip creation
+     * @param dirName Name of the directory to check
+     * @returns True if the directory should be skipped, false otherwise
+     */
+    static shouldSkipDirectory(dirName: string): boolean;
+    /**
+     * Get the folder path from a file or folder path
+     * @param inputPath Path to a file or folder
+     * @returns The folder path
+     */
+    static getFolderPath(inputPath: string): string;
+    /**
+     * Log a summary of the zip archive contents
+     * @param zip JSZip instance to analyze
+     * @param logging Logging interface
+     */
+    static logZipSummary(zip: JSZip, logging: Features['logging']): void;
+    /**
+     * Generate a unique client token for the request
+     * @returns A unique string token
+     */
+    static generateClientToken(): string;
+    /**
+     * Execute git command and return output
+     * @param command Git command to execute
+     * @param type Type of command for logging
+     * @param logging Logging interface
+     * @returns Promise resolving to command output
+     */
+    static executeGitCommand(command: string, type: string, logging: Features['logging']): Promise<string>;
+    /**
+     * Get git diff for a file or folder
+     * @param artifactPath Path to the file or folder
+     * @param logging Logging interface
+     * @returns Git diff output as string or null if not in a git repository
+     */
+    static getGitDiff(artifactPath: string, logging: Features['logging']): Promise<string | null>;
+    /**
+     * Log zip structure
+     * @param zip JSZip instance
+     * @param zipName Name of the zip for logging
+     * @param logging Logging interface
+     */
+    static logZipStructure(zip: JSZip, zipName: string, logging: Features['logging']): void;
+    /**
+     * Count number of files in zip
+     * @param zip JSZip instance
+     * @returns number of files in zip
+     */
+    static countZipFiles(zip: JSZip): number;
+    /**
+     * Generate zip buffer with compression
+     * @param zip JSZip instance
+     * @returns Promise resolving to compressed buffer
+     */
+    static generateZipBuffer(zip: JSZip): Promise<Buffer>;
+    /**
+     * Save zip buffer to Downloads folder
+     * @param zipBuffer Buffer to save
+     * @param logging Logging interface
+     */
+    static saveZipToDownloads(zipBuffer: Buffer, logging: Features['logging']): void;
+    /**
+     * Process artifact with git diff
+     * @param artifact Artifact with path
+     * @param isCodeDiffScan Whether to scan for code diff
+     * @param logging Logging interface
+     * @returns Promise resolving to diff string
+     */
+    static processArtifactWithDiff(artifact: {
+        path: string;
+    }, isCodeDiffScan: boolean, logging: Features['logging']): Promise<string>;
+    /**
+     * Error handling wrapper
+     * @param operation Operation to execute
+     * @param errorMessage Error message prefix
+     * @param logging Logging interface
+     * @param path Optional path for error context
+     * @returns Promise resolving to operation result
+     */
+    static withErrorHandling<T>(operation: () => Promise<T>, errorMessage: string, logging: Features['logging'], path?: string): Promise<T>;
+    /**
+     * Check if agentic review capability is enabled in client capabilities
+     * @param params Initialize parameters from client
+     * @returns True if agentic reviewer is enabled, false otherwise
+     */
+    static isAgenticReviewEnabled(params: InitializeParams | undefined): boolean;
+    /**
+     * Converts a Windows absolute file path to Unix format and removes the drive letter
+     * @param windowsPath The Windows path to convert
+     * @returns The Unix formatted path without drive letter
+     */
+    static convertToUnixPath(windowsPath: string): string;
+    /**
+     * Create a standardized error output object
+     * @param errorObj Error object or message
+     * @returns Formatted InvokeOutput with error details
+     */
+    static createErrorOutput(errorObj: any): InvokeOutput;
+    /**
+     * Upload file content to the pre-signed URL
+     * @param uploadUrl Pre-signed URL for uploading the file
+     * @param fileContent Buffer containing the file content
+     * @param requestHeaders Additional headers for the request
+     * @param logging Logging interface
+     */
+    static uploadFileToPresignedUrl(uploadUrl: string, fileContent: Buffer, requestHeaders: Record<string, string>, logging: Features['logging']): Promise<void>;
+    /**
+     * Handle failure in a consistent way
+     * @param error Error object
+     * @param scanName Optional scan name for context
+     * @param jobId Optional job ID for context
+     * @param logging Logging interface
+     * @param telemetry Telemetry interface
+     * @param toolName Tool name for error messages
+     * @returns Standardized error response
+     */
+    static handleFailure(error: any, logging: Features['logging'], telemetry: Features['telemetry'], toolName: string, scanName?: string, jobId?: string): any;
+    /**
+     * Emit a telemetry metric with standard formatting
+     * @param metricSuffix Suffix for the metric name
+     * @param metricData Additional metric data
+     * @param toolName Tool name for the metric prefix
+     * @param logging Logging interface
+     * @param telemetry Telemetry interface
+     * @param credentialStartUrl Optional credential start URL
+     */
+    static emitMetric(metricSuffix: string, metricData: any, toolName: string, logging: Features['logging'], telemetry: Features['telemetry'], credentialStartUrl?: string): void;
+    /**
+     * Check if cancellation has been requested and throw if it has
+     * @param cancellationToken Cancellation token to check
+     * @param message Optional message for the error
+     * @param logging Logging interface
+     */
+    static checkCancellation(cancellationToken: CancellationToken | undefined, logging: Features['logging'], message?: string): void;
+}