OIP Starter Utils
API Client
L'API client expose les éléments suivants ( named exports ) la méthode start qui permet d'initialiser l'application React ; le hook useProcess qui permet la gestion des transitions et des tâches depuis les composants des vues de l'OAV ; le hook useCommitMutation qui permet la gestion d'une mutation graphQL depuis les composants des vue de l'OAV ; le hook useSubscription qui permet la gestion d'une subscription graphQL depuis les composants des vue de l'OAV ; la définition des queries graphQL TaskSubscription et TaskWorkflowSubscription qui permettent de souscrire à l'état d'une tâche ou d'un workflow de tâches (à utiliser avec le hook useSubscription ) ; le composant Router qui permet d'initialiser les routes de l'OAV et de configurer la navigation navigateur ; le hook useClientSync lié à la fonctionnalité de la synchronisation des connexions clientes ; le hook useBlockBrowserNav qui permet de désactiver la navigation navigateur pour la vue appelante. Les imports depuis l'OAV La méthode start initialise l'application React de l'OAV.
API Server
L'API server expose les éléments suivants ( named exports ) la méthode start qui permet d'initialiser l'application Express ; la méthode getPubSub qui permet de récupérer l'instance PubSub pour la gestion des subscriptions graphQL ; les utilitaires des resolvers graphQL OK et KO ; la méthode handleTask nécessaire à l'éxecution des tâches ; l'utilitaire getEnv qui permet de résoudre la valeur d'une variable d'environnement ; l'utilitaire validateResolverContext qui permet de valider le contexte d'appel d'un resolver d'une vue. Les imports depuis l'OAV La méthode start initialise l'application Express de l'OAV.
Application React
L'application React se lance via une fonction start . La signature de cette fonction est La description des paramètres de la fonction start est app composant React racine de votre application ; ctx paramètre indiquant où lire le contexte de l'OAV ( token et projectId ).
CHANGELOG
Mise à jour des dépendances. Propagation l'identifiant unique de la connexion client clientId dans les fonctions de rappel de décrochage et dans le contexte applicatif ( process ).
Environnement
L'environnement d'exécution a deux configurations possibles production ou développement . Il est déterminé par la variable d'environnement NODE ENV .
Présentation
La bibliothèque OIP Starter Utils permet une mise en place rapide et standardisée d’un parcours de vente basé sur l’écosystème OIP. Elle regroupe les fonctionnalités principales et communes à l’ensemble des OAV paramétrage de l’application React ; paramétrage de l'application Express ; paramétrage de la logique de décrochage, d’authentification et de gestion de sessions ; paramétrage de la couche GraphQL pour la gestion du process, des transitions et des tâches de l’OAV.
Serveur Express
Le serveur Express se lance via une fonction start . La signature de cette fonction est La description des paramètres de la fonction start est cookieOptions objet permettant de configurer la gestion des cookies ; voir la documentation de la bibliothèque cookie-session https //github.