codereview-aia 0.1.0 → 0.1.2

package/dist/types/reviewSchema.d.ts

@@ -0,0 +1,543 @@
+/**
+ * Structured code review schema definitions used by cr-aia prompts and validators.
+ *
+ * We keep the TypeScript interfaces with matching Zod schemas so the runtime,
+ * validator, and prompt generator all stay in sync.
+ */
+import { z } from 'zod';
+/**
+ * Priority level for code review issues
+ */
+export declare enum IssuePriority {
+    HIGH = "HIGH",
+    MEDIUM = "MEDIUM",
+    LOW = "LOW"
+}
+export declare const issuePrioritySchema: z.ZodNativeEnum<typeof IssuePriority>;
+/**
+ * Location of an issue in the code
+ */
+export interface IssueLocation {
+    startLine: number;
+    endLine: number;
+}
+export declare const issueLocationSchema: z.ZodObject<{
+    startLine: z.ZodNumber;
+    endLine: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    startLine: number;
+    endLine: number;
+}, {
+    startLine: number;
+    endLine: number;
+}>;
+/**
+ * A single issue identified in the code review
+ */
+export interface ReviewIssue {
+    id: string;
+    priority: IssuePriority;
+    description: string;
+    location: IssueLocation;
+    currentCode: string;
+    suggestedCode: string;
+    explanation: string;
+}
+export declare const reviewIssueSchema: z.ZodObject<{
+    id: z.ZodString;
+    priority: z.ZodNativeEnum<typeof IssuePriority>;
+    description: z.ZodString;
+    location: z.ZodObject<{
+        startLine: z.ZodNumber;
+        endLine: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        startLine: number;
+        endLine: number;
+    }, {
+        startLine: number;
+        endLine: number;
+    }>;
+    currentCode: z.ZodString;
+    suggestedCode: z.ZodString;
+    explanation: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    priority: IssuePriority;
+    description: string;
+    location: {
+        startLine: number;
+        endLine: number;
+    };
+    currentCode: string;
+    suggestedCode: string;
+    explanation: string;
+}, {
+    id: string;
+    priority: IssuePriority;
+    description: string;
+    location: {
+        startLine: number;
+        endLine: number;
+    };
+    currentCode: string;
+    suggestedCode: string;
+    explanation: string;
+}>;
+/**
+ * Review results for a single file
+ */
+export interface FileReview {
+    filePath: string;
+    issues: ReviewIssue[];
+}
+export declare const fileReviewSchema: z.ZodObject<{
+    filePath: z.ZodString;
+    issues: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        priority: z.ZodNativeEnum<typeof IssuePriority>;
+        description: z.ZodString;
+        location: z.ZodObject<{
+            startLine: z.ZodNumber;
+            endLine: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            startLine: number;
+            endLine: number;
+        }, {
+            startLine: number;
+            endLine: number;
+        }>;
+        currentCode: z.ZodString;
+        suggestedCode: z.ZodString;
+        explanation: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        priority: IssuePriority;
+        description: string;
+        location: {
+            startLine: number;
+            endLine: number;
+        };
+        currentCode: string;
+        suggestedCode: string;
+        explanation: string;
+    }, {
+        id: string;
+        priority: IssuePriority;
+        description: string;
+        location: {
+            startLine: number;
+            endLine: number;
+        };
+        currentCode: string;
+        suggestedCode: string;
+        explanation: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    issues: {
+        id: string;
+        priority: IssuePriority;
+        description: string;
+        location: {
+            startLine: number;
+            endLine: number;
+        };
+        currentCode: string;
+        suggestedCode: string;
+        explanation: string;
+    }[];
+    filePath: string;
+}, {
+    issues: {
+        id: string;
+        priority: IssuePriority;
+        description: string;
+        location: {
+            startLine: number;
+            endLine: number;
+        };
+        currentCode: string;
+        suggestedCode: string;
+        explanation: string;
+    }[];
+    filePath: string;
+}>;
+/**
+ * Summary statistics for the code review
+ */
+export interface ReviewSummary {
+    highPriorityIssues: number;
+    mediumPriorityIssues: number;
+    lowPriorityIssues: number;
+    totalIssues: number;
+}
+export declare const reviewSummarySchema: z.ZodObject<{
+    highPriorityIssues: z.ZodNumber;
+    mediumPriorityIssues: z.ZodNumber;
+    lowPriorityIssues: z.ZodNumber;
+    totalIssues: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    highPriorityIssues: number;
+    mediumPriorityIssues: number;
+    lowPriorityIssues: number;
+    totalIssues: number;
+}, {
+    highPriorityIssues: number;
+    mediumPriorityIssues: number;
+    lowPriorityIssues: number;
+    totalIssues: number;
+}>;
+/**
+ * Complete code review results
+ */
+export interface CodeReview {
+    version: string;
+    timestamp: string;
+    files: FileReview[];
+    summary: ReviewSummary;
+}
+export declare const codeReviewSchema: z.ZodObject<{
+    version: z.ZodString;
+    timestamp: z.ZodString;
+    files: z.ZodArray<z.ZodObject<{
+        filePath: z.ZodString;
+        issues: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            priority: z.ZodNativeEnum<typeof IssuePriority>;
+            description: z.ZodString;
+            location: z.ZodObject<{
+                startLine: z.ZodNumber;
+                endLine: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                startLine: number;
+                endLine: number;
+            }, {
+                startLine: number;
+                endLine: number;
+            }>;
+            currentCode: z.ZodString;
+            suggestedCode: z.ZodString;
+            explanation: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            priority: IssuePriority;
+            description: string;
+            location: {
+                startLine: number;
+                endLine: number;
+            };
+            currentCode: string;
+            suggestedCode: string;
+            explanation: string;
+        }, {
+            id: string;
+            priority: IssuePriority;
+            description: string;
+            location: {
+                startLine: number;
+                endLine: number;
+            };
+            currentCode: string;
+            suggestedCode: string;
+            explanation: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        issues: {
+            id: string;
+            priority: IssuePriority;
+            description: string;
+            location: {
+                startLine: number;
+                endLine: number;
+            };
+            currentCode: string;
+            suggestedCode: string;
+            explanation: string;
+        }[];
+        filePath: string;
+    }, {
+        issues: {
+            id: string;
+            priority: IssuePriority;
+            description: string;
+            location: {
+                startLine: number;
+                endLine: number;
+            };
+            currentCode: string;
+            suggestedCode: string;
+            explanation: string;
+        }[];
+        filePath: string;
+    }>, "many">;
+    summary: z.ZodObject<{
+        highPriorityIssues: z.ZodNumber;
+        mediumPriorityIssues: z.ZodNumber;
+        lowPriorityIssues: z.ZodNumber;
+        totalIssues: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        highPriorityIssues: number;
+        mediumPriorityIssues: number;
+        lowPriorityIssues: number;
+        totalIssues: number;
+    }, {
+        highPriorityIssues: number;
+        mediumPriorityIssues: number;
+        lowPriorityIssues: number;
+        totalIssues: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    timestamp: string;
+    files: {
+        issues: {
+            id: string;
+            priority: IssuePriority;
+            description: string;
+            location: {
+                startLine: number;
+                endLine: number;
+            };
+            currentCode: string;
+            suggestedCode: string;
+            explanation: string;
+        }[];
+        filePath: string;
+    }[];
+    summary: {
+        highPriorityIssues: number;
+        mediumPriorityIssues: number;
+        lowPriorityIssues: number;
+        totalIssues: number;
+    };
+}, {
+    version: string;
+    timestamp: string;
+    files: {
+        issues: {
+            id: string;
+            priority: IssuePriority;
+            description: string;
+            location: {
+                startLine: number;
+                endLine: number;
+            };
+            currentCode: string;
+            suggestedCode: string;
+            explanation: string;
+        }[];
+        filePath: string;
+    }[];
+    summary: {
+        highPriorityIssues: number;
+        mediumPriorityIssues: number;
+        lowPriorityIssues: number;
+        totalIssues: number;
+    };
+}>;
+/**
+ * Root object for the code review schema
+ */
+export interface ReviewSchema {
+    review: CodeReview;
+}
+export declare const reviewSchema: z.ZodObject<{
+    review: z.ZodObject<{
+        version: z.ZodString;
+        timestamp: z.ZodString;
+        files: z.ZodArray<z.ZodObject<{
+            filePath: z.ZodString;
+            issues: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                priority: z.ZodNativeEnum<typeof IssuePriority>;
+                description: z.ZodString;
+                location: z.ZodObject<{
+                    startLine: z.ZodNumber;
+                    endLine: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    startLine: number;
+                    endLine: number;
+                }, {
+                    startLine: number;
+                    endLine: number;
+                }>;
+                currentCode: z.ZodString;
+                suggestedCode: z.ZodString;
+                explanation: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }, {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            issues: {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }[];
+            filePath: string;
+        }, {
+            issues: {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }[];
+            filePath: string;
+        }>, "many">;
+        summary: z.ZodObject<{
+            highPriorityIssues: z.ZodNumber;
+            mediumPriorityIssues: z.ZodNumber;
+            lowPriorityIssues: z.ZodNumber;
+            totalIssues: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            highPriorityIssues: number;
+            mediumPriorityIssues: number;
+            lowPriorityIssues: number;
+            totalIssues: number;
+        }, {
+            highPriorityIssues: number;
+            mediumPriorityIssues: number;
+            lowPriorityIssues: number;
+            totalIssues: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        version: string;
+        timestamp: string;
+        files: {
+            issues: {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }[];
+            filePath: string;
+        }[];
+        summary: {
+            highPriorityIssues: number;
+            mediumPriorityIssues: number;
+            lowPriorityIssues: number;
+            totalIssues: number;
+        };
+    }, {
+        version: string;
+        timestamp: string;
+        files: {
+            issues: {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }[];
+            filePath: string;
+        }[];
+        summary: {
+            highPriorityIssues: number;
+            mediumPriorityIssues: number;
+            lowPriorityIssues: number;
+            totalIssues: number;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    review: {
+        version: string;
+        timestamp: string;
+        files: {
+            issues: {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }[];
+            filePath: string;
+        }[];
+        summary: {
+            highPriorityIssues: number;
+            mediumPriorityIssues: number;
+            lowPriorityIssues: number;
+            totalIssues: number;
+        };
+    };
+}, {
+    review: {
+        version: string;
+        timestamp: string;
+        files: {
+            issues: {
+                id: string;
+                priority: IssuePriority;
+                description: string;
+                location: {
+                    startLine: number;
+                    endLine: number;
+                };
+                currentCode: string;
+                suggestedCode: string;
+                explanation: string;
+            }[];
+            filePath: string;
+        }[];
+        summary: {
+            highPriorityIssues: number;
+            mediumPriorityIssues: number;
+            lowPriorityIssues: number;
+            totalIssues: number;
+        };
+    };
+}>;
+/**
+ * Get the schema as a string for inclusion in prompts
+ */
+export declare function getSchemaAsString(): string;
+/**
+ * Get schema instructions for inclusion in prompts
+ */
+export declare function getSchemaInstructions(): string;

package/dist/types/reviewSchema.js

@@ -0,0 +1,121 @@
+"use strict";
+/**
+ * Structured code review schema definitions used by cr-aia prompts and validators.
+ *
+ * We keep the TypeScript interfaces with matching Zod schemas so the runtime,
+ * validator, and prompt generator all stay in sync.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reviewSchema = exports.codeReviewSchema = exports.reviewSummarySchema = exports.fileReviewSchema = exports.reviewIssueSchema = exports.issueLocationSchema = exports.issuePrioritySchema = exports.IssuePriority = void 0;
+exports.getSchemaAsString = getSchemaAsString;
+exports.getSchemaInstructions = getSchemaInstructions;
+const zod_1 = require("zod");
+/**
+ * Priority level for code review issues
+ */
+var IssuePriority;
+(function (IssuePriority) {
+    IssuePriority["HIGH"] = "HIGH";
+    IssuePriority["MEDIUM"] = "MEDIUM";
+    IssuePriority["LOW"] = "LOW";
+})(IssuePriority || (exports.IssuePriority = IssuePriority = {}));
+// Zod schema for issue priority
+exports.issuePrioritySchema = zod_1.z.nativeEnum(IssuePriority);
+// Zod schema for issue location
+exports.issueLocationSchema = zod_1.z.object({
+    startLine: zod_1.z.number(),
+    endLine: zod_1.z.number(),
+});
+// Zod schema for review issue
+exports.reviewIssueSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    priority: exports.issuePrioritySchema,
+    description: zod_1.z.string(),
+    location: exports.issueLocationSchema,
+    currentCode: zod_1.z.string(),
+    suggestedCode: zod_1.z.string(),
+    explanation: zod_1.z.string(),
+});
+// Zod schema for file review
+exports.fileReviewSchema = zod_1.z.object({
+    filePath: zod_1.z.string(),
+    issues: zod_1.z.array(exports.reviewIssueSchema),
+});
+// Zod schema for review summary
+exports.reviewSummarySchema = zod_1.z.object({
+    highPriorityIssues: zod_1.z.number(),
+    mediumPriorityIssues: zod_1.z.number(),
+    lowPriorityIssues: zod_1.z.number(),
+    totalIssues: zod_1.z.number(),
+});
+// Zod schema for code review
+exports.codeReviewSchema = zod_1.z.object({
+    version: zod_1.z.string(),
+    timestamp: zod_1.z.string(),
+    files: zod_1.z.array(exports.fileReviewSchema),
+    summary: exports.reviewSummarySchema,
+});
+// Zod schema for review schema
+exports.reviewSchema = zod_1.z.object({
+    review: exports.codeReviewSchema,
+});
+/**
+ * Get the schema as a string for inclusion in prompts
+ */
+function getSchemaAsString() {
+    return `
+{
+  "review": {
+    "version": "1.0",
+    "timestamp": "2024-04-06T12:00:00Z",
+    "files": [
+      {
+        "filePath": "path/to/file.ts",
+        "issues": [
+          {
+            "id": "ISSUE-1",
+            "priority": "HIGH",
+            "description": "Description of the issue",
+            "location": {
+              "startLine": 10,
+              "endLine": 15
+            },
+            "currentCode": "function example() {\\n  // Problematic code here\\n}",
+            "suggestedCode": "function example() {\\n  // Improved code here\\n}",
+            "explanation": "Detailed explanation of why this change is recommended"
+          }
+        ]
+      }
+    ],
+    "summary": {
+      "highPriorityIssues": 1,
+      "mediumPriorityIssues": 2,
+      "lowPriorityIssues": 3,
+      "totalIssues": 6
+    }
+  }
+}
+`;
+}
+/**
+ * Get schema instructions for inclusion in prompts
+ */
+function getSchemaInstructions() {
+    return `
+IMPORTANT: In interactive mode, you MUST format your response as a valid JSON object following this exact schema:
+
+${getSchemaAsString()}
+
+Guidelines for filling the schema:
+1. Each issue must have a unique ID (e.g., "ISSUE-1", "ISSUE-2")
+2. Priority must be one of: "HIGH", "MEDIUM", "LOW"
+3. Location should include the start and end line numbers of the affected code
+4. Current code should be the exact code snippet that needs to be changed
+5. Suggested code should be the improved version of the code
+6. Explanation should provide a detailed rationale for the suggested change
+7. The summary should accurately count the number of issues by priority
+
+Your response must be valid JSON that can be parsed programmatically. Do not include any text outside of the JSON structure.
+`;
+}
+//# sourceMappingURL=reviewSchema.js.map

package/dist/types/reviewSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewSchema.js","sourceRoot":"","sources":["../../src/types/reviewSchema.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAuHH,8CAkCC;AAKD,sDAiBC;AA7KD,6BAAwB;AAExB;;GAEG;AACH,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,kCAAiB,CAAA;IACjB,4BAAW,CAAA;AACb,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAED,gCAAgC;AACnB,QAAA,mBAAmB,GAAG,OAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAU/D,gCAAgC;AACnB,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAeH,8BAA8B;AACjB,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;IACd,QAAQ,EAAE,2BAAmB;IAC7B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,2BAAmB;IAC7B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;IACzB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC;AAUH,6BAA6B;AAChB,QAAA,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,yBAAiB,CAAC;CACnC,CAAC,CAAC;AAYH,gCAAgC;AACnB,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,kBAAkB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC9B,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE;IAChC,iBAAiB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC7B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC;AAYH,6BAA6B;AAChB,QAAA,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC;IACvC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,wBAAgB,CAAC;IAChC,OAAO,EAAE,2BAAmB;CAC7B,CAAC,CAAC;AASH,+BAA+B;AAClB,QAAA,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IACnC,MAAM,EAAE,wBAAgB;CACzB,CAAC,CAAC;AAEH;;GAEG;AACH,SAAgB,iBAAiB;IAC/B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCR,CAAC;AACF,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB;IACnC,OAAO;;;EAGP,iBAAiB,EAAE;;;;;;;;;;;;CAYpB,CAAC;AACF,CAAC"}