Manual

JavaScript and TypeScript SDK

Integrate the typed ESM SDK in Node.js and browser-facing applications.

Install

The internal release is an npm-compatible tarball containing built ESM JavaScript, TypeScript declarations, package metadata, manifest, checksum, and isolated-consumer smoke report. Node.js 20 or later is required by the current package metadata.

Client usage

Import from @rtk-cloud/client, create a client with the HTTPS endpoint and adapters, then call the typed request methods. Keep bearer tokens outside committed configuration and avoid exposing device credentials to browser code unless the architecture explicitly supports user-scoped tokens.

Asynchronous behavior

Every network operation returns a promise. Await it inside bounded application workflows, convert SDK errors at the service boundary, and prevent unhandled promise rejections. Use cancellation support where exposed and stop subscriptions or sessions when their owner is disposed.

Browser security

Apply a restrictive Content Security Policy, use HTTPS, and avoid localStorage for long-lived credentials. The SDK does not make an administrative token safe for browser use. Use a trusted backend when an operation requires service credentials or cross-account authority.

Validation

Run npm ci, the TypeScript build, unit tests, package creation, and the isolated consumer smoke. Treat generated declarations as the public TypeScript contract and regenerate the API reference whenever exported declarations change.

Other manual chapters

Continue with related manual sections.

SDK overview

Choose the right package and understand support boundaries.

Open section

Getting started

Install an SDK, configure a client, and complete a first request.

Open section

Authentication and security

Handle bearer tokens, PKI, TLS, keys, and sensitive media safely.

Open section

Lifecycle and errors

Apply timeout, retry, cancellation, callback, and shutdown rules.

Open section

Capability workflows

Integrate provisioning, devices, telemetry, OTA, commands, and signaling.

Open section

Video Cloud workflows

Integrate Live WebRTC signaling and encrypted stored-video upload, browsing, and playback.

Open section

Native C and C++ SDK

Use the stable C ABI, thin C++ wrapper, transports, and streaming uploads.

Open section

Android Kotlin SDK

Use Kotlin APIs, coroutines, Media3 playback, and secure key providers.

Open section

iOS Swift SDK

Use Swift APIs, async operations, AVPlayer, Keychain, and Secure Enclave boundaries.

Open section

Go SDK

Use the pure Go client for devices, tools, and automation.

Open section

FreeRTOS and Pro2 SDK

Integrate board adapters, device transport, and WebRTC answerer boundaries.

Open section

Sample applications

Build and use the Android, iOS, Web, Linux, and Pro2 reference samples.

Open section

Troubleshooting and compatibility

Diagnose common integration problems and identify deprecated behavior.

Open section