@safercity/sdk

Official SaferCity API client for TypeScript/JavaScript.

Installation

npm install @safercity/sdk
# or
bun add @safercity/sdk
# or
yarn add @safercity/sdk

Quick Start

import { createSaferCityClient } from '@safercity/sdk';

const client = createSaferCityClient({
  baseUrl: 'https://api.safercity.com',
  token: 'your-jwt-token',
  tenantId: 'your-tenant-id',
});

// Health check
const { data: health } = await client.health.check();
console.log('API Status:', health.status);

// Get user
const { data: user } = await client.users.get('user-123');
console.log('User:', user);

// Create panic
const { data: panic } = await client.panics.create({
  userId: 'user-123',
  latitude: -26.2041,
  longitude: 28.0473,
});
console.log('Panic created:', panic.id);

Authentication

JWT Token

const client = createSaferCityClient({
  baseUrl: 'https://api.safercity.com',
  token: jwtToken, // Your JWT token
});

// Update token later
client.setToken(newToken);

OAuth Token Flow

const client = createSaferCityClient({
  baseUrl: 'https://api.safercity.com',
});

// Get access token
const { data: tokens } = await client.oauth.token({
  grant_type: 'client_credentials',
  tenantId: 'your-tenant-id',
});

// Set token on client
client.setToken(tokens.access_token);

Streaming (SSE)

Stream real-time panic updates:

for await (const event of client.panics.streamUpdates('panic-123')) {
  console.log('Update:', JSON.parse(event.data));
}

API Reference

Health

• client.health.check() - Check API status

Authentication

• client.auth.whoami() - Get current auth context
• client.oauth.token(body) - Get access token
• client.oauth.refresh(body) - Refresh token
• client.oauth.introspect(body) - Introspect token
• client.oauth.revoke(body) - Revoke token

Users

• client.users.create(body) - Create user
• client.users.list(query?) - List users
• client.users.get(userId) - Get user by ID
• client.users.update(userId, body) - Update user
• client.users.delete(userId) - Delete user

Panics

• client.panics.create(body) - Create panic
• client.panics.get(panicId, query?) - Get panic
• client.panics.list(query?) - List panics
• client.panics.updateLocation(panicId, body) - Update location
• client.panics.cancel(panicId, body) - Cancel panic
• client.panics.streamUpdates(panicId) - Stream updates (SSE)

Subscriptions

• client.subscriptions.listTypes() - List subscription types
• client.subscriptions.create(body) - Create subscription
• client.subscriptions.list(query?) - List subscriptions
• client.subscriptions.stats() - Get stats

Location Safety

• client.locationSafety.check(query) - Check location safety

Crimes

• client.crimes.list(query?) - List crimes
• client.crimes.categories() - Get crime categories
• client.crimes.types() - Get crime types

Error Handling

import { SaferCityApiError } from '@safercity/sdk';

try {
  await client.users.get('invalid-id');
} catch (error) {
  if (error instanceof SaferCityApiError) {
    console.log('API Error:', error.error);
    console.log('Message:', error.message);
    console.log('Status:', error.status);
  }
}

Custom Fetch

For environments with custom fetch requirements:

import { createSaferCityClient } from '@safercity/sdk';

const client = createSaferCityClient({
  baseUrl: 'https://api.safercity.com',
  fetch: customFetchImplementation,
});

Related Packages

• @safercity/sdk-react - React hooks with TanStack Query
• @safercity/sdk-react-native - React Native support with expo-fetch

License

MIT