Skip to main content
The SDK API reference is split across a few focused pages:

Client methods

collection(), blocks(), search(), autocomplete(), uploadImage(), imageSearch(), searchContent(), similarProducts(), facets(), sortOrders(), and the product card controller.

Filtering

Filter DSL, operators, and runtime facet and sort order discovery.

Response types and error handling

Shared QueryState shape, the ApiError class, and the { data, error } pattern.

Cache and storage

Internal cache, storage backends, singleton access, and SDK technical details.

Controller lifecycle at a glance

All controllers follow the same pattern with reactive state and two ways to subscribe:
  • state - a QueryState<T> object with { data, error, loading }
  • get() - runs the query, returns ApiResult<T> ({ data, error })
  • subscribe(callback) - reacts to state changes without importing signals
  • dispose() - cleans up subscriptions and aborts pending requests
See Client methods for the full list.

Next steps