npm SDK

@driftabot/engine is a thin npm wrapper around the driftabot binary. On install, the correct pre-built binary for your platform is downloaded automatically — no Go toolchain required.

Installation

npm install @driftabot/engine

Requires Node.js ≥ 16. Supported platforms: macOS arm64/amd64, Linux arm64/amd64, Windows amd64.

Programmatic API

OpenAPI

import { compareOpenAPI } from "@driftabot/engine";

const result = compareOpenAPI("old.yaml", "new.yaml");

console.log(result.summary);
// { total: 3, breaking: 1, non_breaking: 2, info: 0 }

for (const change of result.changes) {
  console.log(`[${change.severity}] ${change.description}`);
}

GraphQL

import { compareGraphQL } from "@driftabot/engine";

const result = compareGraphQL("old.graphql", "new.graphql");

gRPC / Protobuf

import { compareGRPC } from "@driftabot/engine";

const result = compareGRPC("old.proto", "new.proto");

Impact analysis

Scan source code for references to each breaking change:

import { compareOpenAPI, impact } from "@driftabot/engine";

const result = compareOpenAPI("old.yaml", "new.yaml");

// Returns Hit[] — one entry per matching file:line
const hits = impact(result, "./src");

for (const hit of hits) {
  console.log(`${hit.file}:${hit.line_num}  (${hit.change_path})`);
}

Text, markdown, or GitHub Actions report:

const report = impact(result, "./src", { format: "markdown" });
console.log(report);

// GitHub Actions workflow commands for inline PR annotations
const ghReport = impact(result, "./src", { format: "github" });
console.log(ghReport);

CLI via npx

The driftabot binary is available as an npm bin after install:

npx driftabot openapi --base old.yaml --head new.yaml
npx driftabot graphql --base old.graphql --head new.graphql --format json
npx driftabot impact --diff diff.json --scan ./src

CommonJS

const { compareOpenAPI, impact } = require("@driftabot/engine");

TypeScript types

type Severity = "breaking" | "non-breaking" | "info";

interface Change {
  type: string;        // e.g. "endpoint_removed", "field_type_changed"
  severity: Severity;
  path: string;        // e.g. "/users/{id}"
  method: string;      // e.g. "DELETE"
  location: string;
  description: string;
  before?: string;
  after?: string;
}

interface Summary {
  total: number;
  breaking: number;
  non_breaking: number;
  info: number;
}

interface DiffResult {
  base_file: string;
  head_file: string;
  changes: Change[];
  summary: Summary;
}

interface Hit {
  file: string;
  line_num: number;
  line: string;
  change_type: string;  // e.g. "endpoint_removed"
  change_path: string;  // e.g. "DELETE /users/{id}"
}