Qumo Enterprise TypeScript SDK

The official TypeScript SDK for interacting with the Qumo Enterprise Control Plane. Supports both Node.js (NPM) and Deno environments.

Features

• Modular & Tree-shakable: Import only what you need.
• Layered Architecture:
  • Layer 1 (API): Raw bindings to all Qumo REST endpoints.
  • Layer 2 (Orchestration): High-level workflows for complex tasks like node draining and deployments.
• Isomorphic: Works in the browser, Node.js, and Deno.
• Zero Dependencies: Uses standard fetch and modern ESM.

Installation

NPM / Yarn / PNPM

npm install @qumo/sdk

Deno

Import directly from your registry or local path:

import { createContext } from "path/to/sdk/src/index.ts";

Quick Start

import { createContext, listProjectNodes, safelyDrainNode } from "@qumo/sdk";

// 1. Initialize Context
const ctx = createContext({
  baseUrl: "https://api.qumo.example.com",
  token: "your-admin-token",
});

// 2. Use Layer 1 (Direct API)
const nodes = await listProjectNodes(ctx, "my-project-id");
console.log(`Found ${nodes.length} nodes.`);

// 3. Use Layer 2 (Orchestration)
await safelyDrainNode(ctx, "node-123");

API Modules

The SDK is organized by functional domains:

• auth: Discovery, Authentication, Session management.
• nodes: Relay node listing and state management.
• tenants: Multi-tenancy and organization management.
• projects: Project listing and usage tracking.
• apikeys: API Key lifecycle management.
• iam: Role-based access control and service accounts.
• audit: Audit log retrieval and webhooks.
• notifications: Policy management and alerting.

Development

# Install dependencies
npm install

# Build ESM/CJS bundles
npm run build

# Run tests (via Deno)
npm test

# Type check
npm run lint

License

ISC