Installation

Le SDK JavaScript de ShopiMind est publié sous le nom @shopimind/sdk-js. C'est un client HTTP sortant : votre code appelle l'API ShopiMind, authentifié par la clé API de votre boutique (en-tête spm-api-key).

Prérequis

Élément	Exigence
Node.js	18 ou supérieur
Modules	ESM uniquement (import) — pas de require
Dépendance	axios (installée automatiquement)

Le SDK est ESM-only

@shopimind/sdk-js est livré exclusivement en ESM ("type": "module"). Il n'existe pas de build CommonJS : un require('@shopimind/sdk-js') ne fonctionnera pas. Utilisez la syntaxe import dans un fichier .mjs, un fichier .ts compilé en module ESM, ou un projet dont le package.json déclare "type": "module".

Installer le paquet

# npm
npm install @shopimind/sdk-js

# yarn
yarn add @shopimind/sdk-js

# pnpm
pnpm add @shopimind/sdk-js

axios est la seule dépendance runtime ; elle est installée automatiquement.

Épingler une version

Pour des installations reproductibles, épinglez une version exacte :

# npm
npm install @shopimind/sdk-js@1.0.0

# yarn
yarn add @shopimind/sdk-js@1.0.0

# pnpm
pnpm add @shopimind/sdk-js@1.0.0

Le SDK suit le versionnage sémantique. Pour la politique de versions et le périmètre couvert, voir Périmètre & versions.

Version actuelle

La version courante est 1.0.0. L'API publique est stable et suit pleinement le versionnage sémantique : aucun changement cassant n'interviendra hors d'une version majeure. Épingler une version exacte garantit des installations reproductibles.

Vérifier l'installation

Créez un fichier ESM, par exemple verify.mjs, et importez le client :

import { SpmClient } from '@shopimind/sdk-js';

console.log('SDK ShopiMind chargé :', typeof SpmClient.getClient === 'function');
// → SDK ShopiMind chargé : true

Lancez-le :

node verify.mjs

Si la ligne affiche true, le SDK est correctement installé et l'import ESM fonctionne.

En TypeScript

Le paquet embarque ses propres déclarations de types (@shopimind/sdk-js expose ./dist/index.d.ts). Aucun paquet @types/... séparé n'est requis. Voir TypeScript.

Étape suivante

Vous êtes prêt à créer un client et à appeler l'API : Utilisation.