betterspace-sdk
v1.0.0
Published
BetterSpace Developer API SDK for JavaScript/TypeScript
Maintainers
Readme
@betterspace/sdk
Official JavaScript/TypeScript SDK for the BetterSpace Developer API.
Installation
npm install @betterspace/sdkQuick Start
import { BetterSpace } from '@betterspace/sdk';
const bs = new BetterSpace('bs_live_your_api_key');
// Register a user (auto-creates BetterSpace profile)
const user = await bs.users.register('emp-001', '[email protected]', {
name: 'Priya Sharma',
phone: '+919876543210',
});
// Log mood
await bs.mood.log('emp-001', 4, { activities: ['work', 'exercise'] });
// Run assessment
const result = await bs.assessments.submit('emp-001', 'phq9', [1,2,1,3,0,1,2,1,0]);
console.log(result.severity); // "moderate"
// AI Chat
const chat = await bs.chat.message('emp-001', 'I feel stressed about work');
console.log(chat.response);
// Crisis Detection
const crisis = await bs.crisis.analyze('I feel like giving up');
if (crisis.is_crisis) alert('Crisis detected!');
// Search Therapists
const { therapists } = await bs.therapists.search({ specialization: 'Anxiety', max_price: 2000 });
// Book Session
await bs.bookings.create('emp-001', therapists[0].id, '2026-06-15', '10:00');Modules
| Module | Methods |
|--------|---------|
| bs.users | register(), list(), get() |
| bs.assessments | types(), administer(), submit(), insights() |
| bs.chat | message(), createSession() |
| bs.crisis | analyze(), alerts() |
| bs.therapists | search(), availability() |
| bs.bookings | create(), get() |
| bs.teams | analytics(), burnoutScore(), addMembers() |
| bs.mood | log(), trends(), prompts() |
| bs.sleep | log(), trends() |
| bs.notifications | send() |
| bs.webhooks | create(), list(), events() |
| bs.analytics | moodTrends(), generateReport() |
| bs.tests | list(), score() |
| bs.content | resources(), categories(), liveClasses() |
Error Handling
import { BetterSpace, BetterSpaceError } from '@betterspace/sdk';
try {
await bs.mood.log('emp-001', 4);
} catch (err) {
if (err instanceof BetterSpaceError) {
console.log(err.code); // "user_not_found"
console.log(err.status); // 404
console.log(err.message); // "User not found"
}
}Configuration
const bs = new BetterSpace('bs_live_key', {
baseUrl: 'https://your-custom-domain.com/functions/v1/api-gateway',
});License
MIT
