APIs

Host API

sirius.* is the library your mapping script calls while a message is in flight. It is the same catalog in every language pack — 248 symbols. Studio autocomplete and hover docs are generated from it. The live JSON is GET /studio/sirius-api.

This page is the contract and the index. Every symbol, with signature and return type, is on the family pages:

The contract

Inbound data arrives as msg. You assign result. A run that assigns no result fails with mapping script produced no result.

const order = sirius.json.decode(msg.raw);
order.facility = sirius.table.lookup("facilities", order.site, "UNKNOWN");
sirius.route.push(order);
result = { message: order };

msg includes raw, content_type, sample_name, and — for recognized formats — a parsed msg.parsed tree. Recognized content_type values: json, hl7 / hl7v2, x12 / edi, fhir. Anything else is raw text.

Pure helpers (text, JSON, dates, crypto, parsers) always run. Connector-bound calls (HTTP, database, file, network, SMTP) deliver for real only when Live I/O is enabled and a connector is wired; otherwise they are recorded and simulated (simulated: true on the result).

Languages

Availability:

• Core symbols run in every pack.
• Schema helpers (sirius.schema.parse, sirius.spec.parse, *.parse_schema) are a JavaScript / TypeScript surface.
• Context (route, emit, HTTP, DB, store, …) is available in JavaScript, TypeScript, Lua, and Tcl. Python has the core catalog; Go and WASM use the flat I/O helpers (Query, Send, SiriusHTTPGet, …).

Family index

Every family below is documented with every member on the linked page.

Core — full list

Standards — full list

I/O and runtime — full list

Devices — full list

Worked examples

JSON, text, dates

const obj = sirius.json.decode(msg.raw);
const site = sirius.json.path(obj, "ship.to.site");
const stamp = sirius.datetime.format(sirius.now(), "%Y-%m-%dT%H:%M:%S");
const padded = sirius.text.pad("7", 3, "0", "left"); // "007"

HTTP and databases

const ref = sirius.http.get({ url: "https://example.org/sites/" + site });
const name = sirius.json.decode(ref.body).name;

const rows = sirius.db.query(
  "warehouse",
  "select name from sites where id = ?",
  [site],
);
const ping = sirius.db.ping("warehouse");
if (!ping.ok) sirius.log.warn("warehouse: " + ping.error);

Parameters are always bound. sirius.db.exec commits writes.

Routing

sirius.route.push(out);   // the primary downstream
sirius.emit(extra);       // an additional message
sirius.route.reply(ack);  // source-response only
sirius.reject("bad site");

Store and tables

sirius.store.put("message", "site", site);
const facility = sirius.table.lookup("facilities", site, "UNKNOWN");

Standards

const mrn = sirius.hl7.get(msg.raw, "PID-3.1");
const out = sirius.hl7.set(msg.raw, "PID-5.1", "DOE");
const issues = sirius.fhir.validate(resource, profile);
const ack = sirius.x12.ack(msg.raw, "997", true);

Logging, traces, metrics

sirius.log.info("mapped " + site);
sirius.trace.event("mapped", { site: site });
sirius.metric.inc("messages_mapped");

These light up the Studio run panel and, at runtime, your operations views.

Safety

Keep secrets out of code. Keyed crypto pulls material from managed secrets. Prefer sirius.crypto.constant_time_equal for tokens and MACs. Do not interpolate SQL. Mapping scripts cannot see the host filesystem or the network unless you go through a wired connector.

Discover the live catalog

curl -s "$SIRIUS/studio/sirius-api" | jq '.symbols | length'
curl -s "$SIRIUS/studio/sirius-api" \
  | jq '.symbols[] | select(.family=="http") | {dotted, signature, summary}'

Studio’s editor uses that document. If a symbol is in the catalog, it is in these pages.

Task-oriented walkthrough: Write a transform. Programmable workbench: Studio API.