https://github.com/radio4000/sdk
javascript SDK to interact with radio4000 (browser & node) [supabase wrapper]
https://github.com/radio4000/sdk
javascript jsdocs radio4000 supababe supabase typescript
Last synced: about 9 hours ago
JSON representation
javascript SDK to interact with radio4000 (browser & node) [supabase wrapper]
- Host: GitHub
- URL: https://github.com/radio4000/sdk
- Owner: radio4000
- Created: 2022-10-15T09:29:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-03T17:21:35.000Z (15 days ago)
- Last Synced: 2026-02-04T07:22:56.750Z (14 days ago)
- Topics: javascript, jsdocs, radio4000, supababe, supabase, typescript
- Language: JavaScript
- Homepage: https://sdk.radio4000.com
- Size: 604 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](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
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"]
```
Here's another, where we sign in (use your own credentials), create a channel and a track.
```html
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: '...'
})
```
### 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 start
```
## 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
│ ├── updateChannel(id, changes) → Promise
│ ├── deleteChannel(id) → Promise
│ ├── readChannel(slug) → Promise
│ ├── readChannels(limit?) → Promise
│ ├── readChannelTracks(slug, limit?) → Promise
│ ├── readUserChannels() → Promise
│ ├── canEditChannel(slug) → Promise
│ ├── createImage(file, tags?) → Promise
│ ├── followChannel(followerId, channelId) → Promise
│ ├── unfollowChannel(followerId, channelId) → Promise
│ ├── readFollowers(channelId) → Promise
│ └── readFollowings(channelId) → Promise
│
├── tracks/
│ ├── createTrack(channelId, fields) → Promise
│ ├── updateTrack(id, changes) → Promise
│ ├── deleteTrack(id) → Promise
│ ├── readTrack(id) → Promise
│ └── canEditTrack(track_id) → Promise
│
├── firebase/
│ ├── readChannel(slug) → Promise<{data?, error?}>
│ ├── readChannels({limit?}) → Promise<{data?, error?}>
│ ├── readTracks({channelId?, slug?}) → Promise<{data?, error?}>
│ ├── parseChannel(rawChannel) → v2Channel
│ └── parseTrack(rawTrack, channelId, channelSlug) → v2Track
│
├── 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
│ └── 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
Create a new, tagged release via the github.com website UI. This will trigger our GitHub workflow and publish to npm.