Types et Interfaces

Disponible uniquement avec le module npm et dans un environnement Typescript

Le module @fairandsmart/consent-manager content des définitions des types et d’interfaces en Typescript, ainsi que des helpers afin d’utiliser rapidement l’API Right Consents en toute compatibilité.

Utilisation

Tous les composants de la librairies sont accessibles en les importants depuis leurs endpoints respectifs. La librairie est organisée selon les ressources de l’API Right Consents.

Vous pouvez importer directement un élément depuis la sous-ressource dans le chemin d’import:recommandé.

import { ConsentContext } from '@fairandsmart/consent-manager/consents';

const context: ConsentContext = { ... };

Vous pouvez également importer chaque ressource dans un wrapper contenant tous ses composants comme ceci: déconseillé - peu lisible

import { ConsentsResource } from '@fairandsmart/consent-manager';

const context: ConsentsResource.ConsentContext = { ... };

Interfaces

Dans TypeScript, une interface est une construction qui détermine la signature d’un objet. Contrairement aux classes, elles n’ont pas besoin d'être instanciées avec le mot clé new et peuvent être assignées aux objets javascript à tout moment. Elle permettent une meilleure lisibilité du code et assure sa compatibilité.

De nombreuses interfaces sont disponibles dans @fairandsmart/consent-manager et si vous utilisez TypeScript, lorsque vous utiliserez une méthode de la librairie, vous aurez accès à la variété de définitions mises à votre disposition.

Helpers

Les helpers sont des classes statiques permettant de manipuler nos objets et nos données de différentes façons.

ModelEntryHelper

getActiveVersionIdentifier

Cette méthode prend en paramètre un modèle (de consentement, préférence, email, etc.) et retourne l’identifiant unique de la version ayant le statut ACTIVE.

import { ModelEntryHelper } from '@fairandsmart/consent-manager/models';

const model: Processing = getProcessingModel(); // Récupération d'un modèle - pour l'exemple
const activeVersionId: string = ModelEntryHelper.getActiveVersionIdentifier(model);

console.log(activeVersionId);
// => "processing/processing.001/s3riAl"

getActiveVersion

Cette méthode récupère la version du modèle passé en paramètre ayant le statut ACTIVE. Une seule version peut avoir ce statut à la fois par modèle.

hasActiveVersion

Cette méthode retourne true si il existe une version ayant le statut ACTIVE pour le modèle passé en paramètre.

ConsentHelper

generateContextFromRecord

Cette méthode prend en paramètre un modèle, un record et un langage. Elle retourne ensuite un nouveau contexte valide et compatible avec le record passé en paramètre. Cela permet de regénérer rapidement un nouveau contexte de collecte pour un utilisateur ayant déjà donné un consentement par la passé.