Svelte Commerce × Swell
Svelte Commerce on Swell
Solid core coverage: cart, checkout and sign-in are wired against Swell’s storefront API, authenticated with the store’s public key. Reviews, wishlist, vendors and states are the recorded gaps.
- 23/43 services wired
- @misiki/swell-connector 0.4.0
- Cart wired
- Checkout wired
- Sign-in (auth) wired
What works on Swell today
Cart, checkout and sign-in are wired; reviews, wishlist, vendors and states are not.
Cart
Wired: issues a real request to Swell.
Checkout
Wired: issues a real request to Swell.
Sign-in (auth)
Wired: issues a real request to Swell.
Known gaps: review, wishlist, vendor, state — each is explained under Limitations below.
23 of 43 services wired, read from CONNECTORS.md on , where the package version is recorded too; npm may carry a newer patch. Coverage is traced by a script in the Svelte Commerce repository: a service counts as wired only if it transitively issues an HTTP request, or delegates to one that does. It is not hand-asserted. Some services are Litekart-native concepts with no equivalent elsewhere (reels, deals, chat, gallery, popularity, demo-request, feedback, plugins, banner). They stay documented placeholders on every connector and are excluded from known gaps.
Quick start
From nothing to a Svelte Commerce storefront reading Swell. You need Node.js and a Swell to point it at; the storefront holds no data of its own.
Clone it, choose the connector, point it at Swell
# 1 — get the storefront
git clone https://github.com/itswadesh/svelte-commerce
cd svelte-commerce
# 2 — one connector at a time: remove the two the storefront ships with, add this one
npm uninstall @misiki/litekart-connector @misiki/vendure-connector
npm i @misiki/swell-connector
# 3 — point it at your Swell store
echo PUBLIC_SWELL_API_URL=https://your-store.swell.store >> .env
echo PUBLIC_SWELL_API_KEY=pk_... >> .env
# 4 — run it
npm run dev The guide removes only @misiki/litekart-connector. A fresh clone’s package.json also lists @misiki/vendure-connector, and with two connectors installed and neither of them Litekart’s, the build stops and asks for PUBLIC_CONNECTOR — so this removes both.
Environment variables
| Variable | Required | What it does |
|---|---|---|
PUBLIC_SWELL_API_URL | Yes | Your storefront origin, such as https://<store>.swell.store. Boot fails, naming this variable, if it is missing. |
PUBLIC_SWELL_API_KEY | No | The store’s public key, sent on its own as HTTP Basic to the storefront API. |
PUBLIC_SWELL_STORE_ID | No | The store ID. With the secret key it authenticates Swell’s Backend API, which the connector refuses to call from a browser. |
PUBLIC_SWELL_API_SECRET | No | The secret key, for Backend API calls. See the limitations before setting it. |
PUBLIC_CONNECTOR | No | Only when more than one connector is installed: @misiki/swell-connector names the one this build runs on. |
init.ts hands the connector every PUBLIC_SWELL_* variable that is set, camel-cased. The guide also lists PUBLIC_SWELL_ACCESS_TOKEN, PUBLIC_SWELL_ACCESS_KEY and PUBLIC_SWELL_CHANNEL_ID; the connector’s source does not read them.
Every variable here begins PUBLIC_, and SvelteKit sends PUBLIC_ variables to the browser: treat each value you set as published.
What to set up on Swell
- For cash on delivery, add a manual payment method named
codin Swell’s payment settings; without one, the storefront’s cash-on-delivery option is refused. - Let the storefront’s origin make cross-origin requests to Swell (CORS): in production the browser calls
PUBLIC_SWELL_API_URLdirectly, not only the server.
How the integration works
Swell has two APIs. The storefront API takes the public key alone as HTTP Basic, and it is the one the storefront calls. The Backend API takes the store ID and secret key, and the connector refuses to call it from a browser.
Installing the package is the whole switch. vite.config.ts resolves whichever @misiki/*-connector is installed, and src/lib/core/connectors/init.ts hands it every PUBLIC_SWELL_* variable that is set, camel-cased, at boot — in the server hook for server rendering and in the client hook for the browser, which must reach the same URL in production.
There is no Litekart API behind the storefront here, so store identity — name, logo, currency, menus, plugin toggles, theme colours — comes from src/lib/core/connectors/default-store.json merged under the default export of kitcommerce.config.ts. Until you override it, the store is called “Test”. Any Litekart REST path the connector still inherits is answered from that local data, or resolved empty, rather than requested.
Limitations
- Reviews: not wired.
- Wishlist: not wired.
- Vendors: not wired.
- States and regions: not wired.
- Pages that depend on a service that is not wired render their empty state rather than failing.
- Setting
PUBLIC_SWELL_API_SECRETwould put Swell’s secret key in every visitor’s browser: SvelteKit sendsPUBLIC_variables to the browser, even though the connector only calls the Backend API from the server. - Homepage sections other than the live product list come from the active theme’s static content — the standing rule for themes.
- The Conversational Shopping assistant is Litekart-only; its widget stays hidden when another connector is active.
Troubleshooting
| When you see | What to do |
|---|---|
| Boot fails with “the swell connector is active but PUBLIC_SWELL_API_URL is not set” | Add PUBLIC_SWELL_API_URL to .env. A production Node build and Docker read PUBLIC_* from the process environment rather than .env, so set it on your deploy platform too. |
| The build stops with “Several commerce connectors are installed … Set PUBLIC_CONNECTOR to pick one” | More than one @misiki/*-connector is in package.json and none is Litekart’s. Uninstall the ones you do not run — a fresh clone also lists @misiki/vendure-connector — or set PUBLIC_CONNECTOR='@misiki/swell-connector'. |
| Boot fails with “PUBLIC_…_API_URL is set, but it configures a different backend than the one this build runs on” | Another backend’s variable is still set, usually left over from the one you switched from. Remove it, or install that backend’s connector. PUBLIC_LITEKART_API_URL is exempt: it only points the dev proxy. |
| The store is called “Test”, or shows the wrong name and logo | Store identity is static on this backend. Set name, logo, currencyCode and the rest in the default export of kitcommerce.config.ts; src/lib/core/connectors/default-store.json lists every field. |
[swell] no native implementation for get /api/... in the console | The connector’s REST guard caught a path inherited from Litekart and answered it empty instead of requesting it. Each path is reported once. Harmless if Swell has no such feature; if it has one, the fix belongs in the connector’s matching service. |
http proxy error: api/... ECONNREFUSED in dev | A Litekart REST path was requested from outside the connector, so its guard never saw it. Vite proxies /api to PUBLIC_LITEKART_API_URL, or to localhost:7000. |
The build fails on @misiki/litekart-connector | @misiki/kitcommerce-core declares it as a peer, and vite.config.ts redirects that specifier to whichever connector is installed. Make sure exactly one @misiki/*-connector is listed in package.json. |
Before you rely on it
The one caveat that matters
Read this before choosing
Every connector was written by reading its platform’s authoritative source — an OpenAPI spec, a RAML file, a router registration or the controller source — rather than by running against a store. No connector has been exercised against a live production instance of its platform.
Offer a sandbox or a correctionFAQ
Questions about Svelte Commerce on Swell
Can I run a Swell store on Svelte Commerce today?
Cart, checkout and sign-in are wired; reviews, wishlist, vendors and states are not. Like every connector, it has not been run against a live production Swell store.
How do I switch Svelte Commerce to Swell?
Remove the connectors the storefront ships with, install @misiki/swell-connector, set PUBLIC_SWELL_API_URL in .env and start the dev server. vite.config.ts resolves whichever connector is installed, so no file in the storefront changes.
Which Swell keys does the storefront need?
The public key, for the storefront API. The secret key is for Swell’s Backend API, which the connector will not call from a browser — and because every PUBLIC_ variable reaches the browser, it is better left unset.
Has the Swell connector been run against a real Swell store?
Not against a live production instance — no Svelte Commerce connector has been. It was written by reading Swell’s authoritative API source, and the Svelte Commerce maintainers ask Swell’s own maintainers for a sandbox to run it against.
Sources
This page summarises SWELL.md in the Svelte Commerce repository and the Swell connector’s source, read on , and the coverage in CONNECTORS.md, read on . Where they disagree with this page, they are right and this page is out of date. Swell is a trademark of its owner, named here only to describe compatibility; no endorsement or affiliation is implied — see trademarks.
Read the whole guide
The storefront is the same on every backend; the connector is what changes. SWELL.md has the Swell setup in full, beside the connector’s source.