SDK overview

@junjo.io/sdk is the TypeScript client. Same package runs in Node and the browser; tree-shakeable; one runtime dependency, @junjo.io/shared (the shared type package). Networking uses the built-in fetch. The @junjo.io/sdk/adapters entry bundles jose internally for JWT verification, so the adapters add no install-time dependency either.

Construct a client

import { Junjo } from "@junjo.io/sdk";
 
const junjo = new Junjo({
  apiKey: process.env.JUNJO_API_KEY!,
  // baseUrl: "https://api.junjo.io", // default
});

This example targets a server. The jk_ key is a full-control secret; never expose it to browsers via NEXT_PUBLIC_ / VITE_ style env vars. Browser apps construct with proxy: true and let a backend proxy inject the key; see JunjoProvider + useJunjo.

Every request-making method also accepts an AbortSignal via signal in its options for caller-side cancellation (rejects with code cancelled). The SDK never retries automatically; see the errors reference for the retry stance and retryAfterSeconds.

Trust boundaries

The credential zones (which process may hold the jk_ key, which holds the jadm_ admin token, and what player devices carry instead) are documented on the security model page.

Errors

Every method that talks to the server throws JunjoError for any non-2xx response. The instance preserves the server’s envelope:

import { JunjoError } from "@junjo.io/sdk";
 
try {
  await junjo.groups.create({ kind: "guild", name: "" });
} catch (e) {
  if (e instanceof JunjoError) {
    e.code;    // "bad_request"
    e.status;  // 400
    e.message; // "name: too short"
  }
}

Branch on error.code, not on error.message. Codes are stable; messages are not.

Sub-namespaces

The Junjo instance exposes typed namespaces for each resource. See the per-namespace pages for the methods inside each.

Top-level methods

In addition to the resource namespaces, Junjo exposes a small set of cross-cutting methods directly on the instance.