sipa-bms-ui

Librairie de composants et plugins VueJS pour les projets de l'équipe BMS du groupe Sipa. Créée et maintenue par l'équipe BMS.

Installation

Installer d'abord la librairie avec votre package manager préféré :

``
npm i -D @ouestfrance/sipa-bms-ui
`

> [!NOTE]
> depuis la version 8.0.0 nous avons migré dans l'organisation @ouestfrance. Le nom du package est passé de 'sipa-bms-ui' à @ouestfrance/sipa-bms-ui.

> Attention, cette librairie n'est pas compatible Vue 2 et n'embarque pas le runtime de Vue. Il faut que votre application importe elle-même Vue 3.

> Autre pré-requis: Utiliser vue-router comme router par défaut

Theming

Il faut ajouter le CSS des composants qui a été extrait de manière globale en ajoutant à votre main.js ou main.ts la ligne suivante :

`typescript
import 'sipa-bms-ui/dist/sipa-bms-ui.css';
`

Utilisation

Deux modes d'instanciations sont disponibles pour les composants de la librairie. En mode composant par composant (on-demand) ou de manière globale. Il est recommandé d'utiliser le mode _on demand_ pour avoir des bundle plus petit.

$3

Pour utiliser une version non-publiée de la lib, il faut builder la librairie et faire référence au dossier de la librairie sur le produit. Ensuite, il faut lancer un npm install pour mettre à jour les dépendances. Ensuite, à chaque build futur, les changements seront impactés.

Dans la librairie

`
npm run build
`

Dans le backoffice

`
"devDependencies": {
"@ouestfrance/sipa-bms-ui": "file:../platform-library-vuejs-bms",
}
`

$3

À l'intérieur de votre composant, importer ce que vous souhaitez depuis le paquet @ouestfrance/sipa-bms-ui :

`vue



`

Le coût minimum de la lib est d'environ 900 ko, le tree shaking intervient au delà de cette limite.

$3

Pour la méthode globale, dans votre fichier de montage, il faut importer et utiliser la méthode createBmsUi() :

`typescript
import { createApp } from 'vue';
import { createBmsUi } from '@ouestfrance/sipa-bms-ui';
import App from './App.vue';

createApp(App).use(createBmsUi()).mount('#app');
`

$3

Les plugins suivants sont pour le moment disponibles sur la librairie :

- field : gérer des champs de formulaires très simplistes
- notifications : notifications en mode _toast_.
- confirm : modale de confirmation qui renvoie une promesse
- router-history : sauvegarde les étapes de la navigation
- feature-flipping : gère un feature flipping côté client
- runtime-env : permet d'accéder aux variables d'environnement au runtime
- keycloak-auth-adapter: permet de configurer la connexion à Keycloak

Pour les instancier, il faut les importer et les appeler comme n'importe quel plugin Vue.
Certains composants ne seront pas fonctionnels sans (ex: field pour les champs de formulaire)

`typescript
import { createApp } from 'vue';
import {
createBmsUi,
field,
notifications,
confirmPlugin,
routerHistoryPlugin,
featureFlipperPlugin,
} from '@ouestfrance/sipa-bms-ui';
import App from './App.vue';

createApp(App)
.use(createBmsUi())
.use(field)
.use(notifications)
.use(confirmPlugin)
.use(routerHistoryPlugin)
.use(featureFlipperPlugin, { featureA: false })
.mount('#app');
`

#### Field

Utilisation du plugin field dans un template :

`html



`

#### notifications

Utilisation du plugin notification :

Dans le composant racine, tel que App.vue ou autre

`html

`

`typescript
import { useNotifications } from '@ouestfrance/sipa-bms-ui';

const { success, error } = useNotifications();

const onClickOnButtonOrAfterFormSubmit = () => {
// (text, time). Si 0, dismiss manuel.
success('This is a success', 6000);
};

const onErrorOfSomething = () => {
// même signature que success
error('This is an error');
};
`

#### confirm

Utilisation du plugin confirm :

Dans le composant racine, tel que App.vue ou autre

`html

`

`typescript
import { useConfirm } from '@ouestfrance/sipa-bms-ui';

const { confirm } = useConfirm();

const onNeedToConfirmAction = async () => {
if (await confirm(Question à poser à l'utilisateur)) {
// After, the user has confirmed
} else {
// user has closed or cancelled the operation
}
};
`

#### Router History

Utilisation du plugin router-history :

Dans le composant racine, tel que App.vue ou autre

`html

`

Cela donne accès au composable useRouterHistory et à l'utilisation du BmsBackButton

#### Feature Flipper

Ce plugin donne accès à un debug mode, où le développeur ou un administrateur peut activer / désactiver des fonctionnalités cachées.

Lors de l'installation du plugin, lui donner les features qui sont valables avec la valeur par défaut.

`typescript
app.use(featureFlipperPlugin, { featureA: false });
`

Après un Konami Code, une modal permet de changer les valeurs de ces features.

Ces valeurs sont stockées dans le localStorage.

Si des valeurs sont activées, un bandeau indique que c'est le cas et permet de rouvrir la modal.

Dans les composants, le composable useFeatureFlipper expose la méthode isFeatureEnabled(featureName) pour vérifier ces valeurs.

#### Runtime Env

Ce plugin permet d'accéder à des variables d'environnement déclarées dans un fichier env.json. Cela permet de se baser sur ces valeurs, tout en les typant

env.json

`typescript
{
"API_URL": "http://localhost:3000"
}
`

main.ts

`typescript
import { createApp } from 'vue';
import { createRuntimeEnv, fetchRuntimeEnv } from '@ouestfrance/sipa-bms-ui';
import App from './App.vue';

const app = createApp(App);

fetchRuntimeEnv<{ MY_URL: string }>().then((env) => {
app.use(createRuntimeEnv(env));

app.mount('#app');
});
`

MyComponent.vue

`typescript
import { useRuntimeEnv } from '@ouestfrance/sipa-bms-ui';

const env = useRuntimeEnv();
console.log(env.MY_URL);
`

$3

La librairie expose une méthode keycloakAuthAdapterInit qui permet d'initialiser un objet Keycloak, qui est ensuite injecté avec le plugin keycloakAuthAdapter, et consultable via le composable useKeycloakAuthAdapter.

Voici un exemple d'initialisation d'une authentification Keycloak.

main.ts

`typescript
import {
keycloakAuthAdapter,
keycloakAuthAdapterInit,
} from '@ouestfrance/sipa-bms-ui';

keycloakAuthAdapterInit({
keycloakOptions: {
url: 'KC_URL',
realm: 'KC_REALM',
clientId: 'KC_ClientID',
},
onTokenRefreshed: (token) => {
// store token to use in API calls if needed
},
})
.then((authResponse) => {
app.use(keycloakAuthAdapter, authResponse);
app.mount('#app');
})
.catch((authResponse) => {
// handle unauthenticated or unauthorized user
});
`

MyComponent.vue

`typescript
import { useKeycloakAuthAdapter } from '@ouestfrance/sipa-bms-ui';

const { auth } = useKeycloakAuthAdapter();
const onClick = () => auth?.value?.logout();
``

Pour toute question, contactez l'équipe BMS.