gitlab-auto-reviewers 2.0.0

package/dist/types.d.ts

@@ -0,0 +1,219 @@
+/**
+ * Type Definitions for Auto Reviewers MCP Server
+ *
+ * This module contains all TypeScript interfaces and types used throughout the MCP server.
+ */
+/**
+ * Parameters for the suggest_reviewers tool
+ *
+ * @property project - GitLab project ID or path (e.g., "group/project" or 123)
+ * @property mergeRequestIid - Merge request internal ID (IID)
+ * @property branch - Branch name (alternative to mergeRequestIid)
+ * @property gitlabToken - GitLab API token (optional if set in environment)
+ * @property gitlabUrl - GitLab instance URL (defaults to https://gitlab.com)
+ * @property repoPath - Local repository path for git operations (optional)
+ */
+export interface AutoReviewerParams {
+    project?: string | number;
+    mergeRequestIid?: number;
+    branch?: string;
+    gitlabToken?: string;
+    gitlabUrl?: string;
+    repoPath?: string;
+}
+/**
+ * A suggested reviewer with scoring and reasoning
+ *
+ * @property username - GitLab username of the suggested reviewer
+ * @property reason - Human-readable explanation for the suggestion
+ * @property workload - Current number of open merge requests assigned to this reviewer
+ * @property fte - Full-Time Equivalent (0.0-1.0) indicating availability
+ * @property score - Detailed scoring breakdown (optional)
+ * @property score.total - Total combined score
+ * @property score.breakdown - Score breakdown by category
+ * @property score.breakdown.contribution - Score from code contributions
+ * @property score.breakdown.codeOwnership - Score from CODEOWNERS matches
+ * @property score.breakdown.teamMembership - Score from team membership
+ * @property score.breakdown.availability - Score from FTE availability
+ * @property reasoning - Detailed reasoning with multiple factors (optional)
+ * @property reasoning.primary - Primary reason for the suggestion
+ * @property reasoning.factors - Array of contributing factors
+ * @property reasoning.factors[].type - Type of factor
+ * @property reasoning.factors[].description - Description of this factor's contribution
+ * @property reasoning.factors[].weight - Weight of this factor in the decision
+ * @property workloadDetails - Detailed workload information (optional)
+ * @property workloadDetails.current - Current number of assigned MRs
+ * @property workloadDetails.capacity - Maximum capacity based on FTE
+ * @property workloadDetails.utilizationPercent - Percentage of capacity utilized
+ */
+export interface ReviewerSuggestion {
+    username: string;
+    reason: string;
+    workload: number;
+    fte?: number;
+    score?: {
+        total: number;
+        breakdown: {
+            contribution: number;
+            codeOwnership: number;
+            teamMembership: number;
+            availability: number;
+        };
+    };
+    reasoning?: {
+        primary: string;
+        factors: Array<{
+            type: 'contribution' | 'ownership' | 'team' | 'availability';
+            description: string;
+            weight: number;
+        }>;
+    };
+    workloadDetails?: {
+        current: number;
+        capacity: number;
+        utilizationPercent: number;
+    };
+}
+/**
+ * Result from the suggest_reviewers tool
+ *
+ * @property contributors - Reviewers suggested based on file contributions
+ * @property teamMembers - Reviewers suggested based on team membership
+ * @property codeOwners - Reviewers suggested based on CODEOWNERS file
+ * @property comment - Formatted comment text for posting to GitLab
+ */
+export interface AutoReviewerResult {
+    contributors: ReviewerSuggestion[];
+    teamMembers: ReviewerSuggestion[];
+    codeOwners: ReviewerSuggestion[];
+    comment: string;
+}
+/**
+ * Parameters for the get_contributor_analysis tool
+ *
+ * @property project - GitLab project ID or path
+ * @property mergeRequestIid - Merge request internal ID
+ * @property gitlabToken - GitLab API token (optional if set in environment)
+ * @property gitlabUrl - GitLab instance URL (defaults to https://gitlab.com)
+ */
+export interface ContributorAnalysisParams {
+    project: string | number;
+    mergeRequestIid: number;
+    gitlabToken?: string;
+    gitlabUrl?: string;
+}
+/**
+ * Parameters for the get_reviewer_workload tool
+ *
+ * @property project - GitLab project ID or path
+ * @property gitlabToken - GitLab API token (optional if set in environment)
+ * @property gitlabUrl - GitLab instance URL (defaults to https://gitlab.com)
+ */
+export interface WorkloadAnalysisParams {
+    project: string | number;
+    gitlabToken?: string;
+    gitlabUrl?: string;
+}
+/**
+ * Parameters for the post_comment tool
+ *
+ * @property project - GitLab project ID or path
+ * @property mergeRequestIid - Merge request internal ID
+ * @property branch - Branch name (alternative to mergeRequestIid)
+ * @property comment - Comment text to post
+ * @property gitlabToken - GitLab API token (optional if set in environment)
+ * @property gitlabUrl - GitLab instance URL (defaults to https://gitlab.com)
+ * @property repoPath - Local repository path (optional)
+ */
+export interface PostCommentParams {
+    project?: string | number;
+    mergeRequestIid?: number;
+    branch?: string;
+    comment: string;
+    gitlabToken?: string;
+    gitlabUrl?: string;
+    repoPath?: string;
+}
+/**
+ * Parameters for the invite_reviewers tool
+ *
+ * @property project - GitLab project ID or path
+ * @property mergeRequestIid - Merge request internal ID
+ * @property branch - Branch name (alternative to mergeRequestIid)
+ * @property gitlabToken - GitLab API token (optional if set in environment)
+ * @property gitlabUrl - GitLab instance URL (defaults to https://gitlab.com)
+ * @property repoPath - Local repository path (optional)
+ */
+export interface InviteReviewersParams {
+    project?: string | number;
+    mergeRequestIid?: number;
+    branch?: string;
+    gitlabToken?: string;
+    gitlabUrl?: string;
+    repoPath?: string;
+}
+/**
+ * A contributor to the codebase
+ *
+ * @property id - GitLab user ID (optional)
+ * @property username - GitLab username
+ * @property email - Email address
+ * @property teams - Teams the contributor belongs to (optional)
+ * @property fte - Full-Time Equivalent availability (optional)
+ * @property changes - Files changed by this contributor (optional)
+ */
+export interface Contributor {
+    id?: number;
+    username: string;
+    email: string;
+    teams?: Team[];
+    fte?: number;
+    changes?: Change[];
+}
+/**
+ * A team that a contributor belongs to
+ *
+ * @property name - Team name
+ * @property fte - FTE allocation to this team (optional)
+ */
+export interface Team {
+    name: string;
+    fte?: number;
+}
+/**
+ * A file change made by a contributor
+ *
+ * @property path - File path
+ * @property fragments - Code fragments changed (optional)
+ */
+export interface Change {
+    path: string;
+    fragments?: string[];
+}
+/**
+ * A rule from the CODEOWNERS file
+ *
+ * @property pattern - File pattern (glob or path)
+ * @property owners - List of owner usernames
+ * @property section - Section name from CODEOWNERS file (optional)
+ */
+export interface CodeOwnerRule {
+    pattern: string;
+    owners: string[];
+    section?: string;
+}
+/**
+ * A match between changed files and CODEOWNERS rules
+ *
+ * @property sectionName - Name of the CODEOWNERS section
+ * @property files - List of files matching this rule
+ * @property owners - List of owner usernames for these files
+ * @property approvals - Number of required approvals (optional)
+ */
+export interface CodeOwnerMatch {
+    sectionName: string;
+    files: string[];
+    owners: string[];
+    approvals?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE;YACT,YAAY,EAAE,MAAM,CAAC;YACrB,aAAa,EAAE,MAAM,CAAC;YACtB,cAAc,EAAE,MAAM,CAAC;YACvB,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;KACH,CAAC;IACF,SAAS,CAAC,EAAE;QACV,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,KAAK,CAAC;YACb,IAAI,EAAE,cAAc,GAAG,WAAW,GAAG,MAAM,GAAG,cAAc,CAAC;YAC7D,WAAW,EAAE,MAAM,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC,CAAC;KACJ,CAAC;IACF,eAAe,CAAC,EAAE;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;CACH;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,kBAAkB,EAAE,CAAC;IACnC,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAClC,UAAU,EAAE,kBAAkB,EAAE,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,7 @@
+/**
+ * Type Definitions for Auto Reviewers MCP Server
+ *
+ * This module contains all TypeScript interfaces and types used throughout the MCP server.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "gitlab-auto-reviewers",
+  "version": "2.0.0",
+  "description": "Shared library for GitLab auto-reviewer suggestions with MCP server, CLI, and library modes",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "gitlab-auto-reviewers": "dist/bin/index.js",
+    "auto-reviewers-mcp-server": "dist/bin/deprecated-mcp.js"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "gitlab",
+    "code-review",
+    "auto-reviewer",
+    "merge-request"
+  ],
+  "author": "Frank Renfeng",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/renfeng.cn/state-of-merge-requests.git",
+    "directory": "auto-reviewers"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/renfeng.cn/state-of-merge-requests/-/issues"
+  },
+  "homepage": "https://gitlab.com/renfeng.cn/state-of-merge-requests#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "npm run type-check && tsc",
+    "prepublishOnly": "npm run build",
+    "start": "node dist/index.js",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:unit": "vitest run tests/unit",
+    "test:properties": "vitest run tests/properties",
+    "test:integration": "vitest run tests/integration",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.24.3",
+    "simple-git": "^3.30.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "@vitest/coverage-v8": "^4.0.15",
+    "eslint": "^8.0.0",
+    "fast-check": "^3.15.0",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.15"
+  }
+}