open-index/open-npm huggingface dataset:
npm package: @shoppexio/theme-control-client
Description: Shared Shoppex theme control plane client
Latest version: 0.1.0

# @shoppexio/theme-control-client

Shared JavaScript client for the Shoppex Theme Control Plane.

Use this package if you want to call the Shoppex theme Dev API from your own tooling.

## What It Covers

The client wraps:
- theme inspect and diff
- file read and search
- apply, validate, preview, and publish
- source export and source upload for local `pull` and `push`

## Example

Install from npm:

```bash
bun add @shoppexio/theme-control-client
```

```js
import { ShoppexThemeControlClient } from '@shoppexio/theme-control-client';

const client = new ShoppexThemeControlClient({
  apiUrl: 'https://api.shoppex.io',
  apiKey: process.env.SHOPPEX_API_KEY,
});

const inspection = await client.inspectTheme('theme_123');
console.log(inspection);
```

## Auth

Use a Shoppex API key with the scopes you need.

Common scope sets:
- `themes.read` for inspect, diff, search, read, and backups
- `themes.write` for source uploads, apply, preview, publish, and rollback

## Related Docs

- Hosted local sync: `https://docs.shoppex.io/themes/hosted-theme-sync`
- Theme Control Plane: `https://docs.shoppex.io/themes/theme-control-plane`