# @radio4000/sdk

> JavaScript client for Radio4000 for the browser and node

Latest version **0.8.2** (published 2026-03-21) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @radio4000/sdk
pnpm add @radio4000/sdk
yarn add @radio4000/sdk
bun add @radio4000/sdk
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.8.2 |
| Published | 2026-03-21 |
| First published | 2022-10-15 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 677 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Author | radio4000 |
| Maintainers | user-09876, oskarrough |
| Keywords | radio4000, supabase, sdk |

## Links

- npm: https://www.npmjs.com/package/@radio4000/sdk
- Repository: https://github.com/radio4000/sdk
- Homepage: https://github.com/radio4000/sdk#readme
- Issues: https://github.com/radio4000/sdk/issues
- npm.io page: https://npm.io/package/@radio4000/sdk

## Dependencies (1)

- [@supabase/supabase-js](https://npm.io/package/@supabase/supabase-js.md) ^2.99.3

## Recent versions

- 0.8.2 (latest) — 2026-03-21
- 0.8.1 — 2026-03-10
- 0.8.0 — 2026-02-18
- 0.7.6 — 2026-02-17
- 0.7.5 — 2026-02-17
- 0.7.4 — 2026-02-05
- 0.7.3 — 2026-02-03
- 0.7.2 — 2026-01-15
- 0.7.1 — 2026-01-15
- 0.7.0 — 2026-01-14
- 0.6.5 — 2025-12-03
- 0.6.4 — 2025-12-03
- 0.6.3 — 2025-11-30
- 0.6.2 — 2025-11-29
- 0.6.0 — 2025-11-10
- … 44 more at https://npm.io/package/@radio4000/sdk/versions

## README

[![Publish Package to npmjs](https://github.com/radio4000/sdk/actions/workflows/publish-to-npm-registry.yml/badge.svg)](https://github.com/radio4000/sdk/actions/workflows/publish-to-npm-registry.yml)

# @radio4000/sdk

A JavaScript SDK to interact with [Radio4000](https://radio4000.com) via a browser or node.js.  

It offers authentication as well as full create, read, update and delete of users, channels and tracks. While the SDK has many methods, remember you can always use `sdk.supabase` directly.

## Usage with a build system

```js
import {sdk} from '@radio4000/sdk'

const {data: channels, error} = await sdk.channels.readChannels()
if (error) throw new Error(error)
console.log(channels)
```

## Browser usage via CDN

This example can be copy pasted into any HTML page. We read the latest five channels created.

```html
<script type="module">
  import {sdk} from 'https://cdn.jsdelivr.net/npm/@radio4000/sdk/+esm'

  const {data: channels, error} = await sdk.channels.readChannels(5)
  if (error) throw new Error(error.message)
  console.log(channels.map(c => c.name))
  // [object Array] (5) ["Radio Oskar","ko002","Radio Maretto","Samro","Good Time Radio"]
</script>
```

Here's another, where we sign in (use your own credentials), create a channel and a track.

```html
<script type="module">
  import {sdk} from 'https://cdn.jsdelivr.net/npm/@radio4000/sdk/+esm'

  await sdk.auth.signIn({email: '', password: ''})

  const {data: channel, error} = await sdk.channels.createChannel({
    name: 'My radio',
    slug: 'my-radio',
    description: '...'
  })

  if (error) throw new Error(error.message)

  const {data: track} = await sdk.tracks.createTrack(channel.id, {
    url: 'http://...',
    title: 'Artist - Title',
    description: '...'
  })
</script>
```

### Using your own Supabase instance

The SDK by default connects to the main PostgreSQL maintained by Radio4000 (see `.env`). You can however use whichever you like. Note that the Supabase URL + (anon) Key are public, because we have postgres row policies in place.

```js
import {createClient} from '@supabase/supabase-js'
import {createSdk} from '@radio4000/sdk'

const supabase = createClient(url, key)
const sdk = createSdk(supabase)
```

## Contributing and development

If you'd like to help out, clone the repository, install dependencies and start the local server. The SDK itself is in the `./src` folder and the playground is in `./examples`.

```shell
git clone git@github.com:radio4000/sdk.git radio4000-sdk
cd radio4000-sdk
npm install
npm test
npm start
```

The `.env` file is committed with the public Supabase anon key, so tests and builds work out of the box. To test CRUD operations, copy `.env.example` to `.env.local` and fill in `TEST_USER_EMAIL` and `TEST_USER_PASSWORD`.

## Overview

```
 Radio4000 SDK
  │
  ├── createSdk(supabaseClient) → SDK
  │
  ├── auth/
  │   ├── signUp({email, password, options?}) → Promise
  │   ├── signIn({email, password, options?}) → Promise
  │   ├── signOut() → Promise
  │   └── via sdk.supabase.auth:
  │       ├── signInWithOtp({email}) → Promise (magic link)
  │       └── signInWithOAuth({provider}) → Promise (google or facebook)
  │
  ├── users/
  │   ├── readUser() → Promise<{data?, error?}>
  │   └── deleteUser() → Promise
  │
  ├── channels/
  │   ├── createChannel({id?, name, slug, userId?}) → Promise<SupabaseResponse>
  │   ├── updateChannel(id, changes) → Promise<SupabaseResponse>
  │   ├── deleteChannel(id) → Promise
  │   ├── readChannel(slug) → Promise<SupabaseResponse>
  │   ├── readChannels(limit?) → Promise<SupabaseResponse>
  │   ├── readChannelTracks(slug, limit?) → Promise<SupabaseResponse>
  │   ├── readUserChannels() → Promise
  │   ├── canEditChannel(slug) → Promise<Boolean>
  │   ├── createImage(file, tags?) → Promise
  │   ├── followChannel(followerId, channelId) → Promise<SupabaseResponse>
  │   ├── unfollowChannel(followerId, channelId) → Promise<SupabaseResponse>
  │   ├── readFollowers(channelId) → Promise<SupabaseResponse>
  │   └── readFollowings(channelId) → Promise<SupabaseResponse>
  │
  ├── tracks/
  │   ├── createTrack(channelId, fields) → Promise<SupabaseResponse>
  │   ├── updateTrack(id, changes) → Promise<SupabaseResponse>
  │   ├── deleteTrack(id) → Promise
  │   ├── readTrack(id) → Promise<SupabaseResponse>
  │   └── canEditTrack(track_id) → Promise<Boolean>
  │
  ├── search/
  │   ├── searchChannels(query, {limit?}) → Promise<{data?, error?}>
  │   ├── searchTracks(query, {limit?}) → Promise<{data?, error?}>
  │   └── searchAll(query, {limit?}) → Promise<{data: {channels, tracks}, error?}>
  │
  ├── browse/
  │   ├── query({page?, limit?, table?, select?, orderBy?, orderConfig?, filters?}) → Promise
  │   ├── supabaseOperators: Array<string>
  │   └── supabaseOperatorsTable: Object
  │
  ├── utils/
  │   └── extractTokens(str) → {mentions: string[], tags: string[]}
  │
  └── supabase (Supabase client instance)

  Almost every method returns the {data, error} format
```

### Generate types from database schema

```shell
npx supabase login
npx supabase gen types typescript --project-id SUPABASE_PROJECT_ID > src/database.types.ts
```

### Build system

We use [vite](https://vitejs.dev/) in library mode to bundle the project. The only reason we bundle is for usage directly in a browser environment without a bundler.

- dist/sdk.js (esm, good for browsers and newer node.js after cjs legacy)

Our package.json defines the `main`, `module` and `exports` fields to specify which file should be loaded in which environment. 

## How to release a new version

```
npm version [major/minor/patch] # updates version in package.json and creates a commit + tag
git push && git push --tags
```

This will trigger our GitHub workflow and publish to npm.

---
_Source: https://npm.io/package/@radio4000/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._