IoTroam Client (Node.js + TypeScript)

A TypeScript-first, dependency-free client for the SURF IoTroam REST API.

This package provides a fully typed API client for managing device groups, devices, and profiles in IoTroam. All endpoints, parameters, and responses are statically typed, enabling compile-time safety and excellent IDE autocompletion.

The client is built directly on the native fetch() API and is suitable for Node.js, Bun, Deno, and modern browsers.

---

Features

✅ Strong typing

• Fully typed request paths, methods, parameters, and return values
• Compile-time validation of:
  • required path parameters
  • request bodies
  • query parameters
• No runtime schema validation overhead

🔌 Zero dependencies

• Uses native fetch
• Optional fetchImpl override for:
  • Node < 18
  • testing
  • custom HTTP stacks

🔐 API key handling

• Global API key configured once
• Per-request override via $headers

🧰 Unified request builder

• Automatic:
  • {id} path parameter replacement
  • query string encoding
  • JSON body serialization
  • response parsing
• Full escape hatch via RequestInit

---

Installation

npm install iotroam
Copy

TypeScript typings (.d.ts) are included.

---

Quick start

1) Create a client

import { iotroam } from "iotroam";

const api = iotroam({
    apiKey: process.env.IOTROAM_API_KEY!,
});
Copy

Default base URL:

https://iotroam.nl
Copy

---

2) List device groups

const groups = await iotroam.groups.list({
  limit: 25,
  offset: 0,
});

console.log(groups.items);
console.log("Total:", groups.count);
Copy

---

3) Get group details

const group = await iotroam.groups.get({ id: 123 });

console.log(group.name);
console.log(group.profile?.vlan);
Copy

---

4) List devices in a group

const devices = await iotroam.groups.devices(
    { id: 123 },
    { limit: 10 }
);

devices.items.forEach(device => {
    console.log(device.id, device.name, device.mac);
});
Copy

---

5) Create a device

const device = await iotroam.devices.create({
    name: "sensor-01",
    mac: "AA:BB:CC:DD:EE:FF",
    password: "secret-password",
    owner: {
        type: "group",
        id: 123,
    },
    location: "Lab A",
});
Copy

---

6) Update a device

const updated = await iotroam.devices.update(
    { id: device.id },
    {
        name: "sensor-01-renamed",
        location: "Lab B",
    }
);
Copy

---

7) Delete a device

await iotroam.devices.delete({ id: device.id });
Copy

---

API structure

Groups

Method	Description
groups.list(query?)	List device groups (paged)
groups.get({ id })	Get group details
groups.devices({ id }, query?)	List devices in a group

---

Devices

Method	Description
devices.create(body)	Create a device
devices.get({ id })	Get device details
devices.update({ id }, body)	Update a device
devices.delete({ id })	Delete a device

---

Parameter conventions

Each request follows a consistent parameter model:

{
    $path?:   Record<string, string | number>;
    $query?:  Record<string, any>;
    $body?:   unknown;
    $headers?: {
        "X-API-Key"?: string;
    };
}
Copy

Example with manual headers:

await iotroam.request(
    "/api/v1/group/list",
    "GET",
    {
        $headers: {
            "X-API-Key": "override-key",
        },
    }
);
Copy

---

Generic request access

The low-level request helper is exposed for advanced use cases:

const result = await iotroam.request(
    "/api/v1/device/{id}/details",
    "GET",
    { $path: { id: 123 } }
);
Copy

This is useful for:

• experimenting with new endpoints
• building abstractions
• tooling and automation

---

Error handling

Non-2xx responses throw a standard Error:

try {
    await iotroam.devices.get({ id: 999999 });
} catch (err) {
    console.error(err.message);
}
Copy

The error message includes:

• HTTP status code
• status text
• response body (when available)

---

Runtime requirements

• Node.js 18+ (for global fetch)
• Or any runtime with a WHATWG-compatible fetch
• TypeScript target: ES2020 or newer

---

Documentation

• 📘 TypeDoc https://datalab-rotterdam.github.io/iotroam/

• 📡 IoTroam API documentation https://iotroam.nl/api/v1/docs

---

License

Apache 2.0 See LICENSE

---

Maintainer

DataLab Rotterdam