npm.io
0.4.0 • Published 5h ago

@misiki/evershop-connector

Licence
MIT
Version
0.4.0
Deps
0
Size
1.9 MB
Vulns
0
Weekly
0

@misiki/evershop-connector

NPM Version License TypeScript

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

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

Coverage: 25 of 43 services are wired to the live EverShop API. The remaining 18 have no EverShop 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 evershop-connector and your EverShop backend.

1. Install the Connector

Inside your svelte-commerce project directory, run:

bun i @misiki/evershop-connector

(Or using npm / pnpm / yarn):

npm install @misiki/evershop-connector
# or
pnpm add @misiki/evershop-connector
2. Configure kitcommerce.config.ts

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

// kitcommerce.config.ts
export * from '@misiki/evershop-connector';
3. Configure Credentials

Pass apiUrl (store URL), accessToken (admin bearer token). API docs: https://evershop.io/docs/development/rest-api/overview

import { EverShopConnector } from '@misiki/evershop-connector'

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

const client = new EverShopConnector()

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 live
client.order live
client.coupon live
client.address live
client.review placeholder (no EverShop equivalent)
client.cart live
client.country live
client.state live
client.currency live
client.region placeholder (no EverShop equivalent)
client.page live
client.blog live
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 EverShop equivalent)
client.vendor placeholder (no EverShop equivalent)
client.checkout live
client.upload placeholder (no EverShop equivalent)
client.banner placeholder (no EverShop equivalent)
client.chat placeholder (no EverShop equivalent)
client.contact placeholder (no EverShop equivalent)
client.deal placeholder (no EverShop equivalent)
client.demoRequest placeholder (no EverShop equivalent)
client.enquiry placeholder (no EverShop equivalent)
client.faq placeholder (no EverShop equivalent)
client.feedback placeholder (no EverShop equivalent)
client.gallery placeholder (no EverShop equivalent)
client.home live
client.init live
client.meilisearch live
client.menu live
client.plugins placeholder (no EverShop equivalent)
client.popularSearch placeholder (no EverShop equivalent)
client.popularity placeholder (no EverShop equivalent)
client.reels placeholder (no EverShop equivalent)

Development

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

License

MIT misiki-in

Keywords