Skip to content

TypeScript SDK reference

API reference for the DNSid TypeScript SDK, generated from TSDoc comments. One page per published package (large packages are further divided by member kind):

  • Core SDK (@dnsid-ai/sdk) — Runtime-neutral SDK entry point; inject DNS, fetch, and key-provider implementations.
  • Node runtime (@dnsid-ai/sdk/node) — Node.js conveniences: local file-backed keys, env config, Node identity-manager factories.
  • Protocol core (@dnsid-ai/protocol) — Protocol core: TXT/JWKS parsing, validation, identity verification, runtime interfaces.
  • Transport (@dnsid-ai/transport) — Node-only DNS/HTTPS transport built on Node built-ins and undici.
  • Profile: JOSE (@dnsid-ai/jose) — JOSE profile helpers for JWT and JWS workflows.
  • Profile: HTTP signatures (@dnsid-ai/http-signatures) — RFC 9421 HTTP Message Signatures profile: sign and verify HTTP messages.
  • Profile: Web Bot Auth (@dnsid-ai/web-bot-auth) — Web Bot Auth profile: signed bot requests and the key-directory endpoint.
  • Profile: OIDC (@dnsid-ai/oidc) — OIDC federation profile: token minting and verification (server-side).
  • Key providers: AWS KMS (@dnsid-ai/key-aws) — AWS KMS-backed key provider.
  • Registry (@dnsid-ai/registry) — Registry client and TXT publishing helpers.
  • Transparency log (@dnsid-ai/log-c2sp-tlog) — C2SP tlog-backed lifecycle log reader, writer, and verifier.