✨ feat(analytics): ajout de la version du site [DS-3718] (#868)

GouvernementFR · Jan 30, 2024 · ba5e0c6 · ba5e0c6
1 parent 5b4ffad
commit ba5e0c6
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/src/analytics/doc/analytics/collector/site.md b/src/analytics/doc/analytics/collector/site.md
@@ -18,6 +18,7 @@ window.dsfr.analytics.site
                 type: 'type', // site type
                 region: 'FR-IDF', // region of the website (ISO 3166-2:FR)
                 department: 'FR-75', // department of the website (ISO 3166-2:FR)
+                version: '1.0.0', // version of the website
             },
         }
     };
@@ -112,6 +113,26 @@ Défini le département du site (pour les sites départementaux) au format
 
 * * *
 
+##### version
+
+_String_ (EA: site\_version)
+
+`window.dsfr.analytics.site.version`
+
+Défini la version du site
+
+* * *
+
+##### api
+
+_String_ (EA: api\_version)
+
+`window.dsfr.analytics.site.api`
+
+Retourne la version de l’API DSFR, géré et injecté automatiquement par le script
+
+* * *
+
 ### MÉTHODES
 
 ##### reset (clear = false)

diff --git a/src/analytics/example/config.ejs b/src/analytics/example/config.ejs
@@ -50,6 +50,7 @@
       // type: 'type', // site type
       // region: 'FR-IDF', // region of the website (ISO 3166-2:FR)
       // department: 'FR-75', // department of the website (ISO 3166-2:FR)
+      version: '1.0.0', // version of the website
     },
     /*
     search: {

diff --git a/src/analytics/script/analytics/collector/site/site.js b/src/analytics/script/analytics/collector/site/site.js
@@ -16,6 +16,7 @@ class Site {
     this.type = clear ? undefined : this._config.type;
     this.region = clear ? undefined : this._config.region;
     this.department = clear ? undefined : this._config.department;
+    this.version = clear ? undefined : this._config.version;
     this._api = api.version;
   }
 
@@ -99,6 +100,15 @@ class Site {
     return this._department;
   }
 
+  set version (value) {
+    const valid = validateString(value, 'site.version');
+    if (valid !== null) this._version = valid;
+  }
+
+  get version () {
+    return this._version;
+  }
+
   get api () {
     return this._api;
   }
@@ -113,6 +123,7 @@ class Site {
     if (this.type) layer.push('site_type', normalize(this.type));
     if (this.region) layer.push('site_region', this.region);
     if (this.department) layer.push('site_department', this.department);
+    if (this.version) layer.push('site_version', this.version);
     if (this.api) layer.push('api_version', this.api);
     return layer;
   }