TypeScript SDK

npm install @parmana/sdk

import { ParmanaClient, HttpTransport } from "@parmana/sdk";

const endpoint = "http://localhost:3000";
const apiKey = "my-secret-api-key";

const client = new ParmanaClient({
  endpoint,
  apiKey,
  transport: new HttpTransport({ endpoint, apiKey }),
});

const health = await client.health(); // GET /health, no key required

import {
  ValidationError,
  AuthenticationError,
  AuthorizationError,
  NotFoundError,
  ConflictError,
  ExecutionRejectedError,
  InternalServerError,
  NetworkError,
  TimeoutError,
} from "@parmana/sdk";

try {
  await client.execute(transaction);
} catch (error) {
  if (error instanceof ExecutionRejectedError) {
    console.log(error.message); // "Execution rejected: <policy-specific reason>"
  } else if (error instanceof ValidationError) {
    // 400 — malformed request
  }
}

import {
  createBusinessTransaction,
  ParmanaClient,
  HttpTransport,
} from "@parmana/sdk";

const client = new ParmanaClient({
  endpoint,
  transport: new HttpTransport({ endpoint }),
});

const transaction = createBusinessTransaction({
  principalId: "alice@example.com", // must match your key's allowedPrincipalIds
  purpose: "Vendor payment approval",
  action: "vendor-payment",
  target: "vendor/vendor-123",
  parameters: { amount: 100, currency: "USD" },
  policy: { name: "vendor-payment", version: "2.0.0", schemaVersion: "1.0.0" },
  signals: {
    vendorVerified: true,
    invoiceVerified: true,
    paymentApproved: true,
    sufficientFunds: true,
    paymentAmount: 100,
    riskScore: 5,
    vendorId: "vendor/vendor-123", // boundSignals: SignalIntentBinder rejects this
    // request unless this exactly equals `target` above
  },
});

const trustRecord = await client.execute(transaction);

npm install --workspace=typescript
npm run build   # typescript/
npm run test    # vitest