feat: add trackSiteSearch event to Piwik provider (#312)

angulartics · Nov 7, 2018 · a17238a · a17238a
1 parent 0d3eba7
commit a17238a
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/src/lib/providers/piwik/piwik.spec.ts b/src/lib/providers/piwik/piwik.spec.ts
@@ -152,6 +152,29 @@ describe('Angulartics2Piwik', () => {
       )),
     );
 
+    it('should track search',
+      fakeAsync(inject([Angulartics2, Angulartics2Piwik],
+        (angulartics2: Angulartics2, angulartics2Piwik: Angulartics2Piwik) => {
+          fixture = createRoot(RootCmp);
+
+          const search = {
+            keyword: 'my search string',
+            category: 'my search category',
+            searchCount: 42,
+          };
+
+          angulartics2.eventTrack.next({action: 'trackSiteSearch', properties: search});
+          advance(fixture);
+
+          expect(_paq).toContain(['trackSiteSearch',
+            search.keyword,
+            search.category,
+            search.searchCount,
+          ]);
+        }
+      )),
+    );
+
     it('should track events', fakeAsync(inject([Angulartics2, Angulartics2Piwik],
       (angulartics2: Angulartics2, angulartics2Piwik: Angulartics2Piwik) => {
         fixture = createRoot(RootCmp);

diff --git a/src/lib/providers/piwik/piwik.ts b/src/lib/providers/piwik/piwik.ts
@@ -149,6 +149,25 @@ export class Angulartics2Piwik {
         ];
         break;
 
+      /**
+       * @description Tracks a site search
+       *
+       * @link https://piwik.org/docs/site-search/
+       * @link https://developer.piwik.org/guides/tracking-javascript-guide#internal-search-tracking
+       *
+       * @property keyword (required) Keyword searched for
+       * @property category (optional) Search category
+       * @property searchCount (optional) Number of results
+       */
+      case 'trackSiteSearch':
+        params = [
+          'trackSiteSearch',
+          properties.keyword,
+          properties.category,
+          properties.searchCount,
+        ];
+        break;
+
       /**
        * @description Logs an event with an event category (Videos, Music, Games...), an event
        * action (Play, Pause, Duration, Add Playlist, Downloaded, Clicked...), and an optional