@solibo/solibo-query
v1.1.48
Published
React Query hooks for Solibo SDK
Readme
@solibo/solibo-query
React Query hooks and helpers for consuming the @solibo/solibo-sdk in React apps.
Highlights
- Pure TypeScript, tree-shakeable
- Tiny Provider that wires tokens/baseUrl into the SDK
HomeApi - First-class TanStack React Query (v5) support
- Opinionated query keys and sample hooks for quick start
Installation
When working inside this repository:
# Build the SDK JS package first (produces build/packages/js)
./gradlew :sdk:assembleJsPackage
# Then build this package
cd solibo-query
npm install
npm run buildIn a consumer project:
npm install @tanstack/react-query @solibo/solibo-sdk @solibo/solibo-queryUsage
import React from 'react'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { SoliboProvider, useSoliboApi } from '@solibo/solibo-query'
import { HomeApi } from '@solibo/solibo-sdk'
const qc = new QueryClient()
const api = new HomeApi(/* construct via SoliboSDK or reuse from your app */) // Prefer passing an existing instance
function AppContent() {
const api = useSoliboApi()
// use your queries here
return <div>Ready</div>
}
export default function App() {
return (
<QueryClientProvider client={qc}>
<SoliboProvider
api={api}
baseUrl={process.env.NEXT_PUBLIC_SOLIBO_BASE_URL}
tokens={{ accessToken: '...', refreshToken: '...', userId: '...', clientId: '...' }}
>
<AppContent />
</SoliboProvider>
</QueryClientProvider>
)
}API
SoliboProvider: Context provider that accepts an existingHomeApiinstance and optionalbaseUrl,language, andtokensto configure it.useSoliboApi(): Access the sharedHomeApiinstance.qk: Query key factory skeleton.
Extending
Create your hooks in src/queries and src/mutations using @tanstack/react-query and the useSoliboApi() hook.
CI publishing
On CI, this package installs the latest @solibo/solibo-sdk from npm and builds/publishes @solibo/solibo-query.
The workflow is .github/workflows/publish-solibo-query.yml and requires the NPM_AUTH_TOKEN secret.
