@dolfinai/sdk-core
v0.4.0
Published
Framework-agnostic Dolfin API client: token auth with renewal, typed errors, events, routes, scoped query keys and formatters.
Maintainers
Readme
@dolfinai/sdk-core
The framework-agnostic half of the Dolfin SDK: the typed API client, token auth with renewal, DolfinError,
typed events, routes, scoped query keys and formatters.
Most apps do not install this package. @dolfinai/react depends on it and re-exports everything an app needs
(routes, errors, events, formatters, module keys, theme tokens) from @dolfinai/react and
@dolfinai/react/server. Use @dolfinai/sdk-core directly only for code with no React at all, such as a worker.
- Docs: https://dolfin-sdk-explorer.vercel.app
- React SDK:
@dolfinai/react
API default: omitting both baseUrl and environment selects https://api.dolfinai.co (production). baseUrl takes precedence. environment: "sandbox" uses that same hostname; isolation depends on your Sandbox client/organisation, not a different host. It does not select staging. Set the API URL explicitly and verify your client before test writes.
Server authentication and existing-organisation guide.
npm install @dolfinai/sdk-coreimport { createDolfinClient, formatDolfinError, toDolfinError } from "@dolfinai/sdk-core";
const client = createDolfinClient({
environment: "sandbox",
getOrganisationId: () => organisationId,
// Your backend swaps your user for a Dolfin token (see `@dolfinai/react/server`).
auth: { mode: "token", userId, fetchToken: async () => (await fetch("/api/dolfin/token")).json() },
});
const { data, error } = await client.GET("/v1/bills", { params: { query: { pageSize: 20 } } });
if (error) console.error(formatDolfinError(toDolfinError(error)));| Area | Exports |
| --- | --- |
| Client | createDolfinClient, environments (production, sandbox, local) |
| Auth | token renewal 60s before expiry, one retry after a 401 with the body replayed |
| Errors | DolfinError, toDolfinError, formatDolfinError, isInsufficientRoleError, isModuleNotEntitledError |
| Events | typed domain events (bill.approved, invoice.issued, ...) |
| Routes | DolfinRoute, dolfinRoutePath, DOLFIN_ROUTE_PATTERNS |
| Query keys | dolfinKeys(scope): every key is scoped by environment, user and organisation |
| Formatting | toNumber, formatMoney, formatDate, formatRelative, formatQuantity, ... |
ESM only, Node 20.9 or later. See CHANGELOG.md and LICENSE.
