@devinnn/docdrift 0.1.2 → 0.1.4

package/dist/src/utils/fetch.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchSpec = fetchSpec;
+exports.fetchSpecPost = fetchSpecPost;
+const node_https_1 = __importDefault(require("node:https"));
+const node_http_1 = __importDefault(require("node:http"));
+const TIMEOUT_MS = 30_000;
+function getAgent(_url) {
+    const proxy = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
+    if (proxy) {
+        try {
+            const { HttpsProxyAgent } = require("https-proxy-agent");
+            return new HttpsProxyAgent(proxy);
+        }
+        catch {
+            // Optional dependency not installed
+        }
+    }
+    return undefined;
+}
+/**
+ * Fetch a URL and return the response body as string.
+ * Respects HTTP_PROXY, HTTPS_PROXY; 30s timeout; follows redirects.
+ */
+async function fetchSpec(url) {
+    const parsed = new URL(url);
+    const isHttps = parsed.protocol === "https:";
+    const agent = getAgent(url);
+    return new Promise((resolve, reject) => {
+        const req = (isHttps ? node_https_1.default : node_http_1.default).get(url, { agent: agent ?? undefined, timeout: TIMEOUT_MS }, (res) => {
+            const redirect = res.headers.location;
+            if (redirect && [301, 302, 307, 308].includes(res.statusCode ?? 0)) {
+                req.destroy();
+                fetchSpec(new URL(redirect, url).href).then(resolve).catch(reject);
+                return;
+            }
+            const chunks = [];
+            res.on("data", (chunk) => chunks.push(chunk));
+            res.on("end", () => resolve(Buffer.concat(chunks).toString("utf8")));
+            res.on("error", reject);
+        });
+        req.on("timeout", () => {
+            req.destroy();
+            reject(new Error(`Fetch timeout after ${TIMEOUT_MS}ms`));
+        });
+        req.on("error", reject);
+    });
+}
+/**
+ * POST to a URL with JSON body (e.g. GraphQL introspection).
+ */
+async function fetchSpecPost(url, body) {
+    const parsed = new URL(url);
+    const isHttps = parsed.protocol === "https:";
+    const agent = getAgent(url);
+    const bodyStr = JSON.stringify(body);
+    return new Promise((resolve, reject) => {
+        const options = {
+            hostname: parsed.hostname,
+            port: parsed.port || (isHttps ? 443 : 80),
+            path: parsed.pathname + parsed.search,
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "Content-Length": Buffer.byteLength(bodyStr),
+            },
+            ...(agent && { agent }),
+            timeout: TIMEOUT_MS,
+        };
+        const req = (isHttps ? node_https_1.default : node_http_1.default).request(options, (res) => {
+            const chunks = [];
+            res.on("data", (chunk) => chunks.push(chunk));
+            res.on("end", () => resolve(Buffer.concat(chunks).toString("utf8")));
+            res.on("error", reject);
+        });
+        req.on("timeout", () => {
+            req.destroy();
+            reject(new Error(`Fetch timeout after ${TIMEOUT_MS}ms`));
+        });
+        req.on("error", reject);
+        req.write(bodyStr);
+        req.end();
+    });
+}

package/dist/src/utils/git.js

@@ -1,9 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveDefaultBaseHead = resolveDefaultBaseHead;
 exports.gitChangedPaths = gitChangedPaths;
 exports.gitDiffSummary = gitDiffSummary;
 exports.gitCommitList = gitCommitList;
 const exec_1 = require("./exec");
+/** Resolve default base/head when not provided. Uses GITHUB_* in CI, else merge-base(main, headRef)..headRef. */
+async function resolveDefaultBaseHead(headRef = process.env.GITHUB_SHA ?? "HEAD") {
+    const headSha = headRef;
+    const baseSha = process.env.GITHUB_BASE_SHA;
+    if (baseSha) {
+        return { baseSha, headSha };
+    }
+    for (const branch of ["origin/main", "origin/master", "main", "master"]) {
+        const res = await (0, exec_1.execCommand)(`git merge-base ${branch} ${headRef}`);
+        if (res.exitCode === 0 && res.stdout.trim()) {
+            return { baseSha: res.stdout.trim(), headSha };
+        }
+    }
+    const fallback = await (0, exec_1.execCommand)(`git rev-parse ${headRef}^`);
+    if (fallback.exitCode === 0 && fallback.stdout.trim()) {
+        return { baseSha: fallback.stdout.trim(), headSha };
+    }
+    return { baseSha: headSha, headSha };
+}
 async function gitChangedPaths(baseSha, headSha) {
     const res = await (0, exec_1.execCommand)(`git diff --name-only ${baseSha} ${headSha}`);
     if (res.exitCode !== 0) {

package/docdrift.schema.json

@@ -0,0 +1,438 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://github.com/devinnn/docdrift/docdrift.schema.json",
+  "title": "DocDrift Configuration",
+  "description": "Repository-local config for docdrift (detect and remediate documentation drift with Devin). See docdrift-yml.md for full reference.",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "number",
+      "enum": [
+        1,
+        2
+      ]
+    },
+    "specProviders": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "format": {
+            "type": "string",
+            "enum": [
+              "openapi3",
+              "swagger2",
+              "graphql",
+              "fern",
+              "postman"
+            ]
+          },
+          "current": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "url"
+                  },
+                  "url": {
+                    "type": "string",
+                    "format": "uri"
+                  }
+                },
+                "required": [
+                  "type",
+                  "url"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "local"
+                  },
+                  "path": {
+                    "type": "string",
+                    "minLength": 1
+                  }
+                },
+                "required": [
+                  "type",
+                  "path"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "export"
+                  },
+                  "command": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "outputPath": {
+                    "type": "string",
+                    "minLength": 1
+                  }
+                },
+                "required": [
+                  "type",
+                  "command",
+                  "outputPath"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          },
+          "published": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "required": [
+          "format",
+          "current",
+          "published"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "openapi": {
+      "type": "object",
+      "properties": {
+        "export": {
+          "type": "string",
+          "minLength": 1
+        },
+        "generated": {
+          "type": "string",
+          "minLength": 1
+        },
+        "published": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "export",
+        "generated",
+        "published"
+      ],
+      "additionalProperties": false
+    },
+    "docsite": {
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      ]
+    },
+    "exclude": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "default": []
+    },
+    "requireHumanReview": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "default": []
+    },
+    "pathMappings": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "match": {
+            "type": "string",
+            "minLength": 1
+          },
+          "impacts": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "minLength": 1
+            },
+            "minItems": 1
+          }
+        },
+        "required": [
+          "match",
+          "impacts"
+        ],
+        "additionalProperties": false
+      },
+      "default": []
+    },
+    "allowConceptualOnlyRun": {
+      "type": "boolean",
+      "default": false
+    },
+    "inferMode": {
+      "type": "boolean",
+      "default": true
+    },
+    "devin": {
+      "type": "object",
+      "properties": {
+        "apiVersion": {
+          "type": "string",
+          "const": "v1"
+        },
+        "unlisted": {
+          "type": "boolean",
+          "default": true
+        },
+        "maxAcuLimit": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 2
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "default": [
+            "docdrift"
+          ]
+        },
+        "customInstructions": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "customInstructionContent": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "apiVersion"
+      ],
+      "additionalProperties": false
+    },
+    "policy": {
+      "type": "object",
+      "properties": {
+        "prCaps": {
+          "type": "object",
+          "properties": {
+            "maxPrsPerDay": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 1
+            },
+            "maxFilesTouched": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 12
+            }
+          },
+          "additionalProperties": false
+        },
+        "confidence": {
+          "type": "object",
+          "properties": {
+            "autopatchThreshold": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "default": 0.8
+            }
+          },
+          "additionalProperties": false
+        },
+        "allowlist": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "minItems": 1
+        },
+        "verification": {
+          "type": "object",
+          "properties": {
+            "commands": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "commands"
+          ],
+          "additionalProperties": false
+        },
+        "slaDays": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 7
+        },
+        "slaLabel": {
+          "type": "string",
+          "minLength": 1,
+          "default": "docdrift"
+        },
+        "allowNewFiles": {
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "required": [
+        "prCaps",
+        "confidence",
+        "allowlist",
+        "verification"
+      ],
+      "additionalProperties": false
+    },
+    "docAreas": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "mode": {
+            "type": "string",
+            "enum": [
+              "autogen",
+              "conceptual"
+            ]
+          },
+          "owners": {
+            "type": "object",
+            "properties": {
+              "reviewers": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "minItems": 1
+              }
+            },
+            "required": [
+              "reviewers"
+            ],
+            "additionalProperties": false
+          },
+          "detect": {
+            "type": "object",
+            "properties": {
+              "openapi": {
+                "type": "object",
+                "properties": {
+                  "exportCmd": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "generatedPath": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "publishedPath": {
+                    "type": "string",
+                    "minLength": 1
+                  }
+                },
+                "required": [
+                  "exportCmd",
+                  "generatedPath",
+                  "publishedPath"
+                ],
+                "additionalProperties": false
+              },
+              "paths": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "match": {
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "impacts": {
+                      "type": "array",
+                      "items": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "minItems": 1
+                    }
+                  },
+                  "required": [
+                    "match",
+                    "impacts"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "additionalProperties": false
+          },
+          "patch": {
+            "type": "object",
+            "properties": {
+              "targets": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "requireHumanConfirmation": {
+                "type": "boolean",
+                "default": false
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "name",
+          "mode",
+          "owners",
+          "detect",
+          "patch"
+        ],
+        "additionalProperties": false
+      },
+      "default": []
+    }
+  },
+  "required": [
+    "version",
+    "devin",
+    "policy"
+  ],
+  "additionalProperties": false
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devinnn/docdrift",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "private": false,
   "description": "Detect and remediate documentation drift with Devin sessions",
   "main": "dist/src/index.js",
@@ -12,7 +12,8 @@
     "node": ">=20"
   },
   "files": [
-    "dist/src"
+    "dist/src",
+    "docdrift.schema.json"
   ],
   "repository": {
     "type": "git",
@@ -35,10 +36,17 @@
     "docs:gen": "npm run --prefix apps/docs-site docusaurus -- gen-api-docs api",
     "docs:build": "npm run --prefix apps/docs-site build",
     "docs:serve": "npm run --prefix apps/docs-site start",
-    "docdrift": "tsx src/cli.ts"
+    "docdrift": "tsx src/cli.ts",
+    "schema:generate": "tsx scripts/generate-schema.ts",
+    "prebuild": "npm run schema:generate",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
+    "@ai-sdk/gateway": "^1.0.0",
+    "@inquirer/prompts": "^7.2.0",
     "@octokit/rest": "^21.1.1",
+    "ai": "^4.0.0",
+    "dotenv": "^16.4.5",
     "fastify": "^5.2.1",
     "js-yaml": "^4.1.0",
     "zod": "^3.24.1"
@@ -50,6 +58,7 @@
     "prettier": "^3.5.0",
     "tsx": "^4.19.2",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.5"
+    "vitest": "^3.0.5",
+    "zod-to-json-schema": "^3.25.1"
   }
-}
+}