@misiki/sylius-connector

@misiki/sylius-connector

The Official TypeScript API Connector for connecting svelte-commerce to Sylius E-Commerce Backend.

@misiki/sylius-connector provides a production-ready, fully-typed API client and integration layer that seamlessly bridges svelte-commerce storefronts with Sylius headless e-commerce backends — part of the Litekart connector suite, mirroring the full 43-service surface of @misiki/litekart-connector.

Coverage: 24 of 43 services are wired to the live Sylius API. The remaining 19 have no Sylius equivalent and return empty placeholder data. Each placeholder says why in a comment at the top of its service file.

---

Step-by-Step Integration Guide

Follow these steps to connect svelte-commerce with sylius-connector and your Sylius backend.

1. Install the Connector

Inside your svelte-commerce project directory, run:

bun i @misiki/sylius-connector

(Or using npm / pnpm / yarn):

npm install @misiki/sylius-connector
# or
pnpm add @misiki/sylius-connector

2. Configure kitcommerce.config.ts

In svelte-commerce, open kitcommerce.config.ts and change the export * line to import from @misiki/sylius-connector:

// kitcommerce.config.ts
export * from '@misiki/sylius-connector';

3. Configure Credentials

Pass apiUrl (store URL), accessToken (JWT from /api/v2/shop/authentication-token). API docs: https://api.sylius.com

import { SyliusConnector } from '@misiki/sylius-connector'

// Credentials are set once, statically — the constructor only takes an optional fetch.
SyliusConnector.setCredentials({
  apiUrl: 'https://store.example.com',
  accessToken: 'jwt_token'
})

const client = new SyliusConnector()

const products = await client.product.list({ page: 1, sort: '-createdAt' })

4. Build and Run the Project

Run the development server in svelte-commerce:

bun dev

To build and run the production application:

# Build the project
bun run build

# Preview the built application
bun run preview

Service coverage

Service	Status
client.product	live
client.category	live
client.collection	placeholder (no Sylius equivalent)
client.order	live
client.coupon	live
client.address	live
client.review	live
client.cart	live
client.country	live
client.state	live
client.currency	live
client.region	live
client.page	placeholder (no Sylius equivalent)
client.blog	placeholder (no Sylius equivalent)
client.settings	live
client.store	live
client.paymentMethod	live
client.search	live
client.autocomplete	live
client.user	live
client.auth	live
client.profile	live
client.wishlist	placeholder (no Sylius equivalent)
client.vendor	placeholder (no Sylius equivalent)
client.checkout	live
client.upload	placeholder (no Sylius equivalent)
client.banner	placeholder (no Sylius equivalent)
client.chat	placeholder (no Sylius equivalent)
client.contact	live
client.deal	placeholder (no Sylius equivalent)
client.demoRequest	placeholder (no Sylius equivalent)
client.enquiry	placeholder (no Sylius equivalent)
client.faq	placeholder (no Sylius equivalent)
client.feedback	placeholder (no Sylius equivalent)
client.gallery	placeholder (no Sylius equivalent)
client.home	placeholder (no Sylius equivalent)
client.init	live
client.meilisearch	live
client.menu	live
client.plugins	placeholder (no Sylius equivalent)
client.popularSearch	placeholder (no Sylius equivalent)
client.popularity	placeholder (no Sylius equivalent)
client.reels	placeholder (no Sylius equivalent)

Development

bun install && bun run typecheck && bun run build

License

MIT misiki-in