@sluby/sdk

TypeScript SDK for Sluby, decentralized video infrastructure on Sia. Typed asset management, resumable TUS uploads, and playback URL retrieval, for the browser and Node.

Install

npm install @sluby/sdk

Quickstart

import { SlubyClient } from '@sluby/sdk';

const client = new SlubyClient({
  apiKey: 'sluby_...',
  baseUrl: 'https://api.sluby.app',
  // Optional: where the browser fetches HLS bytes from directly (an object
  // gateway or an nginx cache). Defaults to baseUrl.
  deliveryBaseUrl: 'https://cache.sluby.app',
});

// 1. Upload a video via resumable TUS. The asset is created as the upload
//    begins; read `assetId` to start polling.
const upload = client.uploads.upload(file, {
  title: 'My Video',
  description: 'Demo upload',
  accessTier: 'public',
  onProgress: (percent) => console.log(`${percent}%`),
});
// upload.pause(); upload.resume(); upload.abort();
const videoAssetId = await upload.assetId;
await upload;

// 2. Wait for processing to finish.
const asset = await client.assets.waitForReady(videoAssetId);

// 3. Get an absolute playback URL to hand to a player.
const { playbackUrl } = await client.playback.getUrl(asset.id);

API

• client.uploads — upload() (resumable TUS; returns an awaitable handle with pause() / resume() / abort() / isPaused plus an assetId promise), getStatus(), cancel().
• client.assets — list(), get(), update(), delete(), waitForReady().
• client.playback — getUrl() and getSignedUrl(), both returning an absolute URL (playbackUrl / signedUrl) resolved against the delivery base, plus the raw server path (playbackPath / signedPath).
• client.webhooks — signature verification and event parsing.
• client.resolveDeliveryUrl(path) — turn a server-relative delivery path into an absolute URL.

Errors are typed: AuthenticationError (401/403), NotFoundError (404), RateLimitError (429, with retryAfter), TimeoutError, and the base SlubyError (with statusCode and responseBody).

Pairs with

@sluby/player — a React player that accepts a SlubyClient and an assetId directly.

License

Apache-2.0