sdk-signer-client/docs/API.md

API

Portée

• Contrats d’interface de la bibliothèque cliente pour l’échange de messages avec le serveur sdk-signer.

Contrats d’interface

• Types de messages: MessageType (écoute, token, processus, merkle, device, erreurs).
• Structure des messages client: ClientMessage (type, messageId, apiKey, champs dynamiques).
• Structure des réponses serveur: ServerResponse (type, messageId, error, champs dynamiques).
• Configuration du client: ClientConfig (url, apiKey, timeouts, reconnexion).
• Événements: ClientEvents (open, close, error, message, reconnect).

Erreurs et statuts

• Émissions d’erreurs lors d’échecs de connexion, timeouts de réponse, ou réponses serveur de type ERROR.

Versionnage et compatibilité

• Contrats versionnés via le package de la bibliothèque; compatibilité garantie par le respect des types exportés depuis src/types.ts.