@eldrajs/sdk

The client for the Eldra Web Studio public storefront API: CMS, catalog, cart, checkout handoff, orders, inventory. Framework-free — plain fetch, runs in a browser, in Node, in SSR, at the edge.

pnpm add @eldrajs/sdk

import { createEldraClient } from '@eldrajs/sdk';

const eldra = createEldraClient({ orgId: 'your-organisation-id' });
const { data } = await eldra.catalog.listProducts();

Types come from your gateway

The package ships no response types. Add the Vite plugin and they are generated into your project on every dev start and build, from the gateway you point at:

import { eldra } from '@eldrajs/sdk/vite';

export default defineConfig({
  plugins: [eldra({ orgId: process.env.ELDRA_ORG_ID })],
});

That writes .eldra/web-studio/ — your CMS schemas as types, the gateway's API contract as types, and a typed client wrapper — and from then on eldra.cart.get(id) returns the cart your gateway actually returns. Commit the folder; it is what your CI type-checks against, and the diff is how you see the API change. Without the plugin, responses are unknown and you name the type at the call site.

The full walkthrough is docs/getting-started.md.

Preview mode

Both createEldraClient and the Vite plugin accept previewToken as a string or callback and send it as X-Preview-Token. Configure each separately; the generator never embeds the token in its output. See preview mode for examples and header precedence.

What is in the client

| Group | Methods | | ----------- | ---------------------------------------------------------------------------------------------------------------------- | | catalog | listProducts, getProduct, listCategories, listCollections, getCollection, listCollectionProducts, search | | cms | list, get, getEntryByUniqueField, resolveEntryList | | cart | addItem, get, updateItem, removeItem, applyDiscount, removeDiscount | | checkout | handoffUrl | | orders | get, recover | | inventory | availability | | features | getOrganization, list, isEnabled, getCapabilities |

Every failed request throws EldraHttpError with status and the gateway's problem code. createCartSession and createOrderAccessTokens persist the cart id and order tokens without throwing where storage is unavailable.