@drift-agent/api-drift-engine 2.5.4 → 5.2.0

package/README.md

@@ -2,7 +2,7 @@
 
 API schema diff engine — detect breaking changes in **OpenAPI**, **GraphQL**, and **gRPC** schemas.
 
-Thin npm wrapper around the [`drift-guard`](https://github.com/DriftAgent/api-drift-engine) Go binary. On install, the correct pre-built binary for your platform is downloaded automatically.
+Thin npm wrapper around the [`drift-agent`](https://github.com/DriftAgent/api-drift-engine) Go binary. On install, the correct pre-built binary for your platform is downloaded automatically.
 
 ## Installation
 
@@ -14,32 +14,32 @@ Requires Node.js ≥ 16. The binary is downloaded for your platform (macOS arm64
 
 ## CLI
 
-After installing, the `drift-guard` binary is available as an npm bin:
+After installing, the `drift-agent` binary is available as an npm bin:
 
 ```sh
-npx drift-guard --help
+npx drift-agent --help
 ```
 
 ### OpenAPI
 
 ```sh
-drift-guard openapi --base old.yaml --head new.yaml
-drift-guard openapi --base old.yaml --head new.yaml --format json
-drift-guard openapi --base old.yaml --head new.yaml --fail-on-breaking
+drift-agent openapi --base old.yaml --head new.yaml
+drift-agent openapi --base old.yaml --head new.yaml --format json
+drift-agent openapi --base old.yaml --head new.yaml --fail-on-breaking
 ```
 
 ### GraphQL
 
 ```sh
-drift-guard graphql --base old.graphql --head new.graphql
-drift-guard graphql --base old.graphql --head new.graphql --format markdown
+drift-agent graphql --base old.graphql --head new.graphql
+drift-agent graphql --base old.graphql --head new.graphql --format markdown
 ```
 
 ### gRPC / Protobuf
 
 ```sh
-drift-guard grpc --base old.proto --head new.proto
-drift-guard grpc --base old.proto --head new.proto --format json
+drift-agent grpc --base old.proto --head new.proto
+drift-agent grpc --base old.proto --head new.proto --format json
 ```
 
 ### Impact analysis
@@ -48,15 +48,15 @@ Scan source code for references to each breaking change:
 
 ```sh
 # From a saved diff JSON
-drift-guard openapi --base old.yaml --head new.yaml --format json > diff.json
-drift-guard impact --diff diff.json --scan ./src
+drift-agent openapi --base old.yaml --head new.yaml --format json > diff.json
+drift-agent impact --diff diff.json --scan ./src
 
 # Pipe mode
-drift-guard openapi --base old.yaml --head new.yaml --format json \
-  | drift-guard impact --scan ./src
+drift-agent openapi --base old.yaml --head new.yaml --format json \
+  | drift-agent impact --scan ./src
 
 # Output as markdown
-drift-guard impact --diff diff.json --scan ./src --format markdown
+drift-agent impact --diff diff.json --scan ./src --format markdown
 ```
 
 ## Node.js / TypeScript API

package/index.d.ts

@@ -34,7 +34,7 @@ export interface Hit {
 }
 
 export interface ImpactOptions {
-  format?: "text" | "json" | "markdown";
+  format?: "text" | "json" | "markdown" | "github";
 }
 
 /** Diff two OpenAPI 3.x schemas (YAML or JSON). */
@@ -51,5 +51,5 @@ export function compareGRPC(base: string, head: string): DiffResult;
  * Returns Hit[] when format is "json" (default), otherwise a formatted string.
  */
 export function impact(diffResult: DiffResult, scanDir?: string, options?: ImpactOptions & { format: "json" }): Hit[];
-export function impact(diffResult: DiffResult, scanDir?: string, options?: ImpactOptions & { format: "text" | "markdown" }): string;
+export function impact(diffResult: DiffResult, scanDir?: string, options?: ImpactOptions & { format: "text" | "markdown" | "github" }): string;
 export function impact(diffResult: DiffResult, scanDir?: string, options?: ImpactOptions): Hit[] | string;

package/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Programmatic API — wraps the drift-guard binary and returns parsed results.
+// Programmatic API — wraps the drift-agent binary and returns parsed results.
 
 const path = require("path");
 const { spawnSync } = require("child_process");
@@ -7,22 +7,22 @@ const { spawnSync } = require("child_process");
 const BIN = path.join(
   __dirname,
   "bin",
-  process.platform === "win32" ? "drift-guard.exe" : "drift-guard"
+  process.platform === "win32" ? "drift-agent.exe" : "drift-agent"
 );
 
 /**
- * Run the drift-guard binary and return its stdout.
+ * Run the drift-agent binary and return its stdout.
  * @param {string[]} args
  * @returns {string}
  */
 function run(args) {
   const result = spawnSync(BIN, args, { encoding: "utf8" });
   if (result.error) {
-    throw new Error(`drift-guard binary error: ${result.error.message}`);
+    throw new Error(`drift-agent binary error: ${result.error.message}`);
   }
   if (result.status !== 0 && result.status !== 1) {
     // exit 1 means breaking changes found (--fail-on-breaking), not a crash
-    throw new Error(`drift-guard exited with code ${result.status}: ${result.stderr}`);
+    throw new Error(`drift-agent exited with code ${result.status}: ${result.stderr}`);
   }
   return result.stdout;
 }
@@ -70,7 +70,7 @@ function impact(diffResult, scanDir = ".", options = {}) {
   const os = require("os");
 
   // Write the diff result to a temp file so we can pass --diff
-  const tmp = require("path").join(os.tmpdir(), `drift-guard-diff-${Date.now()}.json`);
+  const tmp = require("path").join(os.tmpdir(), `drift-agent-diff-${Date.now()}.json`);
   try {
     fs.writeFileSync(tmp, JSON.stringify(diffResult));
     const out = run(["impact", "--diff", tmp, "--scan", scanDir, "--format", format]);

package/install.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-// postinstall: downloads the drift-guard binary from GitHub Releases.
+// postinstall: downloads the drift-agent binary from GitHub Releases.
 "use strict";
 
 const https = require("https");
@@ -11,7 +11,7 @@ const { execSync } = require("child_process");
 const VERSION = require("./package.json").version;
 const REPO = "DriftAgent/api-drift-engine";
 const BIN_DIR = path.join(__dirname, "bin");
-const BIN_PATH = path.join(BIN_DIR, process.platform === "win32" ? "drift-guard.exe" : "drift-guard");
+const BIN_PATH = path.join(BIN_DIR, process.platform === "win32" ? "drift-agent.exe" : "drift-agent");
 
 // Map Node.js platform/arch → goreleaser archive naming
 function getPlatformInfo() {
@@ -32,7 +32,7 @@ function getPlatformInfo() {
   }
 
   const ext = goos === "windows" ? "zip" : "tar.gz";
-  const archive = `drift-guard_${VERSION}_${goos}_${goarch}.${ext}`;
+  const archive = `drift-agent_${VERSION}_${goos}_${goarch}.${ext}`;
   const url = `https://github.com/${REPO}/releases/download/v${VERSION}/${archive}`;
 
   return { url, archive, ext };
@@ -64,10 +64,10 @@ async function install() {
   }
 
   const { url, archive, ext } = getPlatformInfo();
-  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "drift-guard-"));
+  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "drift-agent-"));
   const archivePath = path.join(tmpDir, archive);
 
-  process.stdout.write(`Downloading drift-guard v${VERSION}...\n`);
+  process.stdout.write(`Downloading drift-agent v${VERSION}...\n`);
 
   try {
     await download(url, archivePath);
@@ -80,18 +80,18 @@ async function install() {
       execSync(`unzip -o "${archivePath}" -d "${tmpDir}"`);
     }
 
-    const extracted = path.join(tmpDir, process.platform === "win32" ? "drift-guard.exe" : "drift-guard");
+    const extracted = path.join(tmpDir, process.platform === "win32" ? "drift-agent.exe" : "drift-agent");
     fs.copyFileSync(extracted, BIN_PATH);
     fs.chmodSync(BIN_PATH, 0o755);
 
-    process.stdout.write(`drift-guard installed to ${BIN_PATH}\n`);
+    process.stdout.write(`drift-agent installed to ${BIN_PATH}\n`);
   } finally {
     fs.rmSync(tmpDir, { recursive: true, force: true });
   }
 }
 
 install().catch((err) => {
-  process.stderr.write(`drift-guard install failed: ${err.message}\n`);
+  process.stderr.write(`drift-agent install failed: ${err.message}\n`);
   process.stderr.write("You can install it manually: https://github.com/DriftAgent/api-drift-engine/releases\n");
   // Do not exit(1) — allow npm install to succeed even if binary download fails.
 });

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@drift-agent/api-drift-engine",
-  "version": "2.5.4",
+  "version": "5.2.0",
   "description": "API schema diff engine — detect breaking changes in OpenAPI, GraphQL, and gRPC schemas",
   "main": "index.js",
   "types": "index.d.ts",
   "bin": {
-    "drift-guard": "run.js"
+    "drift-agent": "run.js"
   },
   "scripts": {
     "postinstall": "node install.js"

package/run.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-// Thin shim: passes all arguments to the drift-guard binary.
+// Thin shim: passes all arguments to the drift-agent binary.
 "use strict";
 
 const path = require("path");
@@ -8,14 +8,14 @@ const { spawnSync } = require("child_process");
 const bin = path.join(
   __dirname,
   "bin",
-  process.platform === "win32" ? "drift-guard.exe" : "drift-guard"
+  process.platform === "win32" ? "drift-agent.exe" : "drift-agent"
 );
 
 const result = spawnSync(bin, process.argv.slice(2), { stdio: "inherit" });
 
 if (result.error) {
   process.stderr.write(
-    `drift-guard: could not run binary: ${result.error.message}\n` +
+    `drift-agent: could not run binary: ${result.error.message}\n` +
     `Make sure the package installed correctly or download manually:\n` +
     `https://github.com/DriftAgent/api-drift-engine/releases\n`
   );