README.md

@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

Usage

With browser 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)
</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'
	
  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>

With build system and npm

import {sdk} from '@radio4000/sdk'

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

Using your own Supabase instance

You're not limited to use the default Radio4000 supabase database.

Supply your own like this:

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 git@github.com:radio4000/sdk.git radio4000-sdk
cd radio4000-sdk
npm install
npm start

Environment variables

This SDK connects to the main Radio4000 PostgreSQL database via Supabase.

1. cp .env.example .env
2. Fill out the .env file

Note that the Supabase URL + (anon) Key are public, because we have postgres row policies in place.

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. We output two files:

• dist/sdk.js (esm, good for browsers and newer node.js)

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. That will trigger the GitHub action to publish to NPM.