Dominus SDK for Node.js

TypeScript/ESM SDK for Dominus platform services. The SDK exposes a singleton (dominus) with namespace-based APIs for auth, data, storage, AI/runtime, workflow execution, job processing, and platform administration.

Install

npm install dominus-sdk-nodejs

Quick Start

import { dominus } from 'dominus-sdk-nodejs';

// Service auth (PSK from DOMINUS_TOKEN)
const tables = await dominus.db.tables('public');

// User auth flow
const session = await dominus.portal.login('[email protected]', 'password');
const me = await dominus.portal.me(session.access_token as string);

// AI runtime
const result = await dominus.ai.runAgent({
  conversationId: 'conv-1',
  systemPrompt: 'You are concise.',
  userPrompt: 'Summarize current task status.'
});

// Files
const uploaded = await dominus.files.upload(Buffer.from('hello'), 'hello.txt');

Configuration

Required in most environments:

• DOMINUS_TOKEN: service PSK used to mint internal JWTs.

Optional:

• DOMINUS_GATEWAY_URL (default: https://gateway.getdominus.app)
• DOMINUS_BASE_URL (legacy override; defaults to gateway)
• DOMINUS_JWT_URL, DOMINUS_LOGS_URL
• DOMINUS_HTTP_PROXY, DOMINUS_HTTPS_PROXY
• DOMINUS_CAPTURE_CONSOLE=true to auto-forward console.* into dominus.logs

Architecture Summary

• Primary source is src/ (not dist/).
• All namespaces call through DominusClient (src/lib/client.ts).
• Requests use Dominus wire format (base64 request/response wrapping).
• Gateway route transform: SDK /api/* calls can be routed to gateway /svc/* when useGateway is enabled.
• Auth model:
  • service-to-service: PSK -> minted JWT cache
  • user calls: pass userToken to namespace methods when required
• Retry + circuit-breaker behavior is implemented in client/cache libraries.

Namespaces

SDK singleton namespaces available on dominus:

• secrets, db, secure, redis, files, auth, ddl, logs, portal, courier, open, health, stt, admin, ai, workflow, sync, jobs, processor, artifacts

Root shortcuts are also exposed for common secrets/db/ddl methods (get, upsert, listTables, queryTable, etc.).

Documentation

• Architecture
• Routes/Services/Endpoints Assessment
• Comprehensive Usage Reference (all namespaced commands)

Development

npm ci
npm run build
npm run lint
npm test

CI publish workflows exist for development, staging, and production branches under .github/workflows/.

Notes

• dominus.stt (OracleNamespace) uses browser APIs (getUserMedia, Web Audio, WebSocket). It is not server-only Node runtime functionality.
• This repository currently contains no committed test suite implementation even though a npm test script is defined.