@nexbasira/node

Serwerowy SDK TypeScript. Pokrywa każdy zasób publicznego API typowanymi kształtami żądań i odpowiedzi, helpery paginacji kursorowej oraz weryfikator podpisu webhooka działający w czasie stałym.

Instalacja

npm install @nexbasira/node

Wymaga Node 18+. Obsługiwane zarówno ESM, jak i CommonJS.

Inicjalizacja

import { NexBasira } from "@nexbasira/node";

const nb = new NexBasira({
  apiKey: process.env.NB_PUBLIC_KEY!,    // nb_pub_*
  apiSecret: process.env.NB_SECRET_KEY!, // nb_sec_*
  // baseURL: "https://app.nexbasira.com/api/v1/public", // default
  // timeout: 30_000,                                          // default
});

Zasoby

Każdy zasób publicznego API ma typowanego klienta w instancji cvp:

nb.sessions       // create / list / retrieve / end / invite
nb.evidence       // list / retrieve / signed download URL
nb.whiteboards    // list per session
nb.webhooks       // register / rotate-secret / test-fire / constructEvent
nb.branding       // read-only
nb.org            // read-only

Częste wzorce

Utwórz + zaproś

const session = await nb.sessions.create({
  notes: "Vehicle damage claim CL-2026-0042",
  scheduled_for: "2026-05-23T10:00:00Z",
  locale: "fr",
});

const invite = await nb.sessions.invite(session.id, {
  recipient_email: "alex@policyholder.com",
  send_email: true,
});

console.log(invite.url); // shown ONCE

Paginacja async-iterator

Endpointy listujące zwracają iterator asynchroniczny, który stronicuje przezroczyście. Koniec z "pamiętaj, aby przekazać cursor z poprzedniej odpowiedzi":

for await (const session of nb.sessions.list({ limit: 50 })) {
  console.log(session.id, session.status);
}

// Or a single page if you want pagination control:
const page = await nb.sessions.listPage({ limit: 25 });
// page.data, page.has_more, page.next_cursor

Idempotentny POST

Przekaż idempotencyKey, aby uczynić zapis bezpiecznym przy ponowieniu:

const session = await nb.sessions.create(
  { notes: "..." },
  { idempotencyKey: crypto.randomUUID() },
);

Backend cache'uje odpowiedź według (klucz, poświadczenie) przez 24 godziny. Ponowiony POST z tym samym kluczem zwraca oryginalną odpowiedź bez ponownego tworzenia zasobu.

Weryfikacja webhooka

import express from "express";
import { NexBasira, InvalidSignatureError } from "@nexbasira/node";

const app = express();
const nb = new NexBasira({ apiKey: "...", apiSecret: "..." });

// IMPORTANT: use express.raw() — constructEvent needs the untouched
// bytes the signature was computed over.
app.post("/nb-webhook", express.raw({ type: "application/json" }), (req, res) => {
  try {
    const event = nb.webhooks.constructEvent(
      req.body,
      req.header("NB-Signature")!,
      process.env.NB_WEBHOOK_SECRET!,
    );
    // event.type is type-narrowed; event.data is the resource shape
    switch (event.type) {
      case "session.completed":
        return onCompleted(event.data, res);
      case "audit.anchored":
        return onAnchored(event.data, res);
    }
    res.status(204).end();
  } catch (err) {
    if (err instanceof InvalidSignatureError) {
      return res.status(401).send("bad signature");
    }
    throw err;
  }
});

Typowane błędy

SDK rzuca niewielką hierarchię typowanych błędów, abyś mógł obsłużyć każdą klasę świadomie:

try {
  await nb.sessions.create({ ... });
} catch (err) {
  if (err instanceof RateLimitError) {
    await sleep(err.retryAfterMs);
    return retry();
  }
  if (err instanceof NexBasiraError) {
    log.warn({ status: err.status, code: err.code }, "cvp error");
  }
  throw err;
}

Typy OpenAPI

SDK jest dostarczany z typami żądań i odpowiedzi generowanymi przez openapi-typescript pod @nexbasira/node/types. Importuj je bezpośrednio, jeśli chcesz mieć silnie typowane handlery powyżej wywołania SDK:

import type { Session, Evidence, WebhookEvent } from "@nexbasira/node/types";

function onSessionCompleted(session: Session) {
  // ...
}

Co dalej

• Referencja API sesji
• Webhooki dogłębnie
• Błędy + limity szybkości
• Źródło na GitHub