@radio4000/sdk

A JavaScript SDK to interact with Radio4000 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

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.

<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.

<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.

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.

git clone [email protected]: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<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

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

Build system

We use vite 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

• Update version in package.json in a git commit
• Git tag the same commit with a version number (no v-prefix)

This will trigger our GitHub workflow and publish to npm.