@approvals/sdk

Tiny SDK for the Approvals API.

Install

npm i @approvals/sdk

Usage

import { Approvals } from "@approvals/sdk";

const approvals = new Approvals({
  apiKey: process.env.APPROVALS_API_KEY!,
  env: "sandbox",
  projectId: "local_project"
});

const artifact = await approvals.createArtifact({
  external_ref: "doc_123",
  type: "url",
  title: "Homepage copy",
  metadata: { team: "marketing" }
});

const revisions = await approvals.listRevisions(artifact.artifact.id);

const approval = await approvals.createApprovalRequest({
  artifact_id: artifact.artifact.id,
  revision_id: revisions.revisions[0].id,
  title: "Ship v1",
  policy: { rule: "ALL_OF", approvers: [{ email: "[email protected]" }] }
});

await approvals.submitDecision(approval.approval_request.id, {
  decision: "APPROVE",
  actor: { email: "[email protected]" }
});

Webhook signature verification

import { Approvals } from "@approvals/sdk";

const ok = Approvals.verifyWebhook({
  secret: process.env.APPROVALS_WEBHOOK_SECRET!,
  timestamp,
  signature,
  rawBody
});