solibo-sdk

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.no by 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	The compiled Kotlin/JS SDK — core API client, models, authentication
@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-react if you are building a React application (it re-exports everything from @solibo/solibo-query).
• Use @solibo/solibo-query directly if you are building with Vue, Solid, or any other framework — it has no React dependency.
• Use @solibo/solibo-sdk directly if you want raw SDK access without TanStack Query.

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.

Support

If you encounter any issues or have questions, please reach out to us at solibohome@solibo.no.