@proofline/sdk

Typed TypeScript client for the Proofline review API. It reads and requests reviews with a scoped API token, and adds pagination, waiting for a review, retries and typed errors. It needs Node 22 or newer.

npm install @proofline/sdk

import { ProoflineClient } from "@proofline/sdk";

const client = new ProoflineClient({
  baseUrl: "https://proofline.sh",
  token: process.env.PROOFLINE_TOKEN!,
});

The client reads PROOFLINE_TOKEN when no token is passed, keeps the token in memory and redacts it from diagnostic output. The SDK guide and API reference cover every operation.

Licensed under the Apache License, Version 2.0.

Development

The repository bundles its public API contract in openapi.public.json. Run pnpm install --frozen-lockfile, pnpm generate, pnpm build, pnpm lint, pnpm typecheck and pnpm test.

Publishing

GitHub Actions runs the checks on pull requests and main. The Release workflow builds checked artifacts without publishing credentials. Run it on main with publish=false to verify the release path. A vX.Y.Z tag matching the package version, or a main-branch dispatch with publish=true, publishes after the npm environment approves the job. Release commits must belong to main.

Publishing uses GitHub OIDC and the repository's release.yml trusted publisher. No registry token is stored in GitHub.

SDK patch releases can update packaging and publishing independently. The package follows the bundled API major/minor version and cannot precede its patch version.