Solibo SDK Documentation
Welcome to the official documentation for the Solibo SDK. This library provides a unified, Kotlin Multiplatform (KMP) interface to consume Solibo Home services across JVM, Android, iOS, and Web (JS/TS/React).
For more information about Solibo Home, visit home.solibo.no.
Overview
The Solibo SDK is designed to be:
- Default Connectivity: Points to
https://api.home.solibo.noby default for zero-config setup. - Multi-platform: Consistent logic and API across JVM, JS, and mobile platforms.
- State-aware: Seamless integration with TanStack React Query for web applications.
- Type-safe: Strongly typed models generated from our core API specifications.
npm Packages
| Package | Description |
|---|---|
@solibo/solibo-sdk | JavaScript-native API client plus models, authentication, event bus, and explicit raw KMP interop |
@solibo/solibo-query | Framework-agnostic TanStack Query option factories (*QueryOptions, *MutationOptions, query keys, utilities) |
@solibo/solibo-react | React hooks (use*()) wrapping solibo-query — for React applications |
Choosing the right package:
- Use
@solibo/solibo-reactfor hooks and its provider in a React application. - Use
@solibo/solibo-querydirectly if you are building with Vue, Solid, or any other framework — it has no React dependency. - Use
@solibo/solibo-sdkfor direct API calls, models, authentication, or raw KMP access.
The packages are deliberately layered rather than re-exporting each other. Import each symbol from the package that owns it.
Quick Links
- Getting Started: Installation and basic configuration.
- Authentication & MFA: Detailed login flows and MFA management.
- Advanced Setup: Platform-specific implementations and custom client configuration.
- Usage Examples: Practical code snippets for both Kotlin and React.
- Event Bus: Real-time updates and WebSocket communication.
- API Reference: High-level overview of available services and models.
- MockHomeApi Testing Guide: In-memory mock backend for testing application flows without a real server.
- KMP Idiosyncrasies: Kotlin Multiplatform quirks to be aware of when consuming the SDK from JavaScript/TypeScript.
- Changelog: API changes and JavaScript migration notes.
Support
If you encounter any issues or have questions, please reach out to us at solibohome@solibo.no.