@diffmind/shared-types 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Diffmind Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+/**
+ * diffmind shared types
+ *
+ * Single source of truth for all output types produced by the ReviewAnalyzer
+ * Wasm core and consumed by the CLI and (future) browser extension.
+ */
+/** Severity classification of a finding. */
+export type Severity = "high" | "medium" | "low";
+/** Ordered severity levels for sorting/filtering. */
+export declare const SEVERITY_ORDER: Record<Severity, number>;
+/** Category of a review finding. */
+export type Category = "security" | "quality" | "performance" | "maintainability";
+/**
+ * A single finding detected in a git diff.
+ * Matches the JSON structure returned by `ReviewAnalyzer.analyze_diff()`.
+ */
+export interface ReviewFinding {
+    /** Relative file path, e.g. `src/auth/auth.controller.ts` */
+    file: string;
+    /** Line number in the diff where the issue was detected */
+    line: number;
+    /** Severity classification */
+    severity: Severity;
+    /** Category classification */
+    category: Category;
+    /** Human-readable description of the issue */
+    issue: string;
+    /** Concrete code fix suggestion */
+    suggested_fix: string;
+    /** Self-rated model confidence (0–1). Present when model supports it. */
+    confidence?: number;
+}
+/** The full analysis result — an array of findings. Empty array = no issues. */
+export type ReviewReport = ReviewFinding[];
+/**
+ * Parse the raw JSON string returned by the Wasm core into a typed ReviewReport.
+ * Returns an empty array if parsing fails (graceful degradation).
+ */
+export declare function parseReport(raw: string): ReviewReport;
+/**
+ * Sort findings by severity (high → medium → low), then by file, then by line.
+ */
+export declare function sortFindings(findings: ReviewReport): ReviewReport;
+/**
+ * Filter findings by minimum severity level.
+ * e.g. `filterBySeverity(report, "medium")` returns high + medium only.
+ */
+export declare function filterBySeverity(findings: ReviewReport, minSeverity: Severity): ReviewReport;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEjD,qDAAqD;AACrD,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAInD,CAAC;AAIF,oCAAoC;AACpC,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,aAAa,GAAG,iBAAiB,CAAC;AAIlF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,8BAA8B;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,gFAAgF;AAChF,MAAM,MAAM,YAAY,GAAG,aAAa,EAAE,CAAC;AAI3C;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAQrD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,YAAY,CAQjE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,YAAY,EACtB,WAAW,EAAE,QAAQ,GACpB,YAAY,CAGd"}

package/dist/index.js

@@ -0,0 +1,57 @@
+"use strict";
+/**
+ * diffmind shared types
+ *
+ * Single source of truth for all output types produced by the ReviewAnalyzer
+ * Wasm core and consumed by the CLI and (future) browser extension.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEVERITY_ORDER = void 0;
+exports.parseReport = parseReport;
+exports.sortFindings = sortFindings;
+exports.filterBySeverity = filterBySeverity;
+/** Ordered severity levels for sorting/filtering. */
+exports.SEVERITY_ORDER = {
+    high: 0,
+    medium: 1,
+    low: 2,
+};
+// ─── Parsing Helpers ──────────────────────────────────────────────────────────
+/**
+ * Parse the raw JSON string returned by the Wasm core into a typed ReviewReport.
+ * Returns an empty array if parsing fails (graceful degradation).
+ */
+function parseReport(raw) {
+    try {
+        const parsed = JSON.parse(raw);
+        if (!Array.isArray(parsed))
+            return [];
+        return parsed;
+    }
+    catch {
+        return [];
+    }
+}
+/**
+ * Sort findings by severity (high → medium → low), then by file, then by line.
+ */
+function sortFindings(findings) {
+    return [...findings].sort((a, b) => {
+        const severityDiff = exports.SEVERITY_ORDER[a.severity] - exports.SEVERITY_ORDER[b.severity];
+        if (severityDiff !== 0)
+            return severityDiff;
+        const fileDiff = a.file.localeCompare(b.file);
+        if (fileDiff !== 0)
+            return fileDiff;
+        return a.line - b.line;
+    });
+}
+/**
+ * Filter findings by minimum severity level.
+ * e.g. `filterBySeverity(report, "medium")` returns high + medium only.
+ */
+function filterBySeverity(findings, minSeverity) {
+    const threshold = exports.SEVERITY_ORDER[minSeverity];
+    return findings.filter((f) => exports.SEVERITY_ORDER[f.severity] <= threshold);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAqDH,kCAQC;AAKD,oCAQC;AAMD,4CAMC;AA/ED,qDAAqD;AACxC,QAAA,cAAc,GAA6B;IACtD,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,GAAG,EAAE,CAAC;CACP,CAAC;AAmCF,iFAAiF;AAEjF;;;GAGG;AACH,SAAgB,WAAW,CAAC,GAAW;IACrC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,OAAO,EAAE,CAAC;QACtC,OAAO,MAAsB,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,QAAsB;IACjD,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACjC,MAAM,YAAY,GAAG,sBAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,sBAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC7E,IAAI,YAAY,KAAK,CAAC;YAAE,OAAO,YAAY,CAAC;QAC5C,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,QAAQ,KAAK,CAAC;YAAE,OAAO,QAAQ,CAAC;QACpC,OAAO,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAC9B,QAAsB,EACtB,WAAqB;IAErB,MAAM,SAAS,GAAG,sBAAc,CAAC,WAAW,CAAC,CAAC;IAC9C,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC,CAAC;AACzE,CAAC"}

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+describe("shared-types", () => {
+    const mockFindings = [
+        {
+            file: "auth.ts",
+            line: 10,
+            severity: "high",
+            category: "security",
+            issue: "Hardcoded secret",
+            suggested_fix: "Use environment variables",
+        },
+        {
+            file: "utils.ts",
+            line: 5,
+            severity: "low",
+            category: "quality",
+            issue: "Shadowing variable",
+            suggested_fix: "Rename variable",
+        },
+        {
+            file: "auth.ts",
+            line: 2,
+            severity: "medium",
+            category: "performance",
+            issue: "Inefficient loop",
+            suggested_fix: "Use map()",
+        },
+    ];
+    describe("parseReport", () => {
+        it("should parse valid JSON matching ReviewReport", () => {
+            const json = JSON.stringify(mockFindings);
+            expect((0, index_1.parseReport)(json)).toEqual(mockFindings);
+        });
+        it("should return an empty array for invalid JSON", () => {
+            expect((0, index_1.parseReport)("invalid")).toEqual([]);
+        });
+        it("should return an empty array if parsed result is not an array", () => {
+            expect((0, index_1.parseReport)('{"issue": "test"}')).toEqual([]);
+        });
+    });
+    describe("sortFindings", () => {
+        it("should sort by severity (high > medium > low)", () => {
+            const sorted = (0, index_1.sortFindings)(mockFindings);
+            expect(sorted[0].severity).toBe("high");
+            expect(sorted[1].severity).toBe("medium");
+            expect(sorted[2].severity).toBe("low");
+        });
+        it("should sort by file and line within the same severity", () => {
+            const sameSeverity = [
+                { ...mockFindings[0], line: 20 },
+                { ...mockFindings[0], line: 5 },
+                { ...mockFindings[0], file: "a.ts" },
+            ];
+            const sorted = (0, index_1.sortFindings)(sameSeverity);
+            expect(sorted[0].file).toBe("a.ts");
+            expect(sorted[1].file).toBe("auth.ts");
+            expect(sorted[1].line).toBe(5);
+            expect(sorted[2].line).toBe(20);
+        });
+    });
+    describe("filterBySeverity", () => {
+        it("should filter findings by minimum severity", () => {
+            const highOnly = (0, index_1.filterBySeverity)(mockFindings, "high");
+            expect(highOnly).toHaveLength(1);
+            expect(highOnly[0].severity).toBe("high");
+            const mediumAndAbove = (0, index_1.filterBySeverity)(mockFindings, "medium");
+            expect(mediumAndAbove).toHaveLength(2);
+            expect(mediumAndAbove.map((f) => f.severity)).toContain("high");
+            expect(mediumAndAbove.map((f) => f.severity)).toContain("medium");
+        });
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,mCAKiB;AAEjB,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,YAAY,GAAoB;QACpC;YACE,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,EAAE;YACR,QAAQ,EAAE,MAAM;YAChB,QAAQ,EAAE,UAAU;YACpB,KAAK,EAAE,kBAAkB;YACzB,aAAa,EAAE,2BAA2B;SAC3C;QACD;YACE,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,CAAC;YACP,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,SAAS;YACnB,KAAK,EAAE,oBAAoB;YAC3B,aAAa,EAAE,iBAAiB;SACjC;QACD;YACE,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,CAAC;YACP,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,aAAa;YACvB,KAAK,EAAE,kBAAkB;YACzB,aAAa,EAAE,WAAW;SAC3B;KACF,CAAC;IAEF,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,CAAC,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,CAAC,IAAA,mBAAW,EAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;YACvE,MAAM,CAAC,IAAA,mBAAW,EAAC,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,YAAY,GAAoB;gBACpC,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;gBAChC,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;gBAC/B,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;aACrC,CAAC;YACF,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,QAAQ,GAAG,IAAA,wBAAgB,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE1C,MAAM,cAAc,GAAG,IAAA,wBAAgB,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAChE,MAAM,CAAC,cAAc,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAChE,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@diffmind/shared-types",
+  "version": "0.1.0",
+  "description": "Shared TypeScript types for diffmind review findings",
+  "license": "MIT",
+  "author": "Thinkgrid Labs <hello@thinkgrid.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thinkgrid-labs/diffmind.git",
+    "directory": "packages/shared-types"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5.4.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "test": "jest"
+  }
+}