@b10cks/client
v1.0.0
Published
Core b10cks API client
Readme
@b10cks/client
Core API client for b10cks, a headless CMS and content management platform.
Installation
npm install @b10cks/clientUsage
import { ApiClient, createB10cksDataApi } from '@b10cks/client'
const client = new ApiClient(
{
baseUrl: 'https://api.b10cks.com/api',
token: 'your-access-token',
fetchClient: fetch,
},
new URL(window.location.href)
)
const dataApi = createB10cksDataApi(client)
// Fetch blocks
const blocks = await dataApi.getBlocks()
// Fetch all contents with pagination
const contents = await dataApi.getContents()
// Fetch specific datasource entries
const entries = await dataApi.getDataEntries('my-datasource')Features
- Simple HTTP Client: Type-safe API client for b10cks endpoints
- Framework-Agnostic Data API: Shared
B10cksDataApiused by all framework SDKs - Pagination Support: Automatic handling of paginated responses
- Revision Tracking: Built-in support for revision (RV) and version (VID) parameters
- Flexible Fetch: Use browser fetch, Node fetch, or a custom fetch implementation
API Methods
get<T>(endpoint, params)- Fetch single page of datagetAll<T>(endpoint, params)- Fetch all data across pages
Data API Methods
getContent(fullSlug, params)getContents(params)getBlocks(params)getDataEntries(source, params)getDataSources(params)getSpace(params)getRedirects(params, forceRefresh)getConfig(options)syncRevision(fallbackRv)
Supported Endpoints
blocks- Content blockscontents- Content itemscontents/{id}- Specific contentdatasources- Data sourcesdatasources/{id}/entries- Datasource entriesspaces/me- Current space info
License
MIT
