Reference
Entry points
Import only the Carpo SDK modules your application uses.
The package provides focused export paths so browser code can avoid server dependencies and service only apps do not need to load React.
| Import | Main exports | Use it for |
|---|---|---|
@carpodev/carpo-sdk | createCarpoClient, service clients, shared types, CarpoApiError | Combined browser client |
@carpodev/carpo-sdk/auth | createCarpoAuthClient | Standalone Better Auth React client |
@carpodev/carpo-sdk/database | createCarpoDatabaseClient, Database types, CarpoApiError | Policy checked Database Data API |
@carpodev/carpo-sdk/functions | createCarpoFunctionsClient | Deployed Function invocation |
@carpodev/carpo-sdk/realtime | createCarpoRealtimeClient, Realtime types | Database change subscriptions |
@carpodev/carpo-sdk/storage | createCarpoStorageClient, Storage types and errors | Policy checked bucket operations |
@carpodev/carpo-sdk/react | CarpoProvider, React hooks | React context and TanStack Query |
@carpodev/carpo-sdk/server | createCarpoServerClient, server service factories | Combined server client |
@carpodev/carpo-sdk/server/auth | createCarpoServerAuthClient | Better Auth server client |
@carpodev/carpo-sdk/server/database | createCarpoServerDatabaseClient | Native @libsql/client connection |
@carpodev/carpo-sdk/server/storage | createCarpoServerStorageClient | Server key Storage client and usage |
@carpodev/carpo-sdk/server/request | createCarpoServerRequestClient | Request scoped Auth, Data API, Storage, and Functions |
The package root does not export React hooks. Import those from /react. The server Database driver is available only from /server or /server/database; browser entry points do not connect directly to Turso.
Client factories
| Factory | Required configuration | Returned services |
|---|---|---|
createCarpoClient() | apiUrl, projectId, databaseId | Auth, Database, Functions, optional Storage |
createCarpoAuthClient() | apiUrl, projectId | Better Auth React client |
createCarpoDatabaseClient() | apiUrl, projectId, databaseId | Database Data API and Realtime |
createCarpoFunctionsClient() | apiUrl, projectId | Functions |
createCarpoRealtimeClient() | apiUrl, projectId, databaseId | Database Realtime subscriptions |
createCarpoStorageClient() | apiUrl, projectId, bucketId | Storage API |
createCarpoServerClient() | apiUrl, projectId | Auth and Functions, optional Database and Storage |
createCarpoServerRequestClient() | request, apiUrl, projectId | Auth and Functions, optional policy checked Database and Storage |
All clients that accept an environment use production or development. The default is production.