Core: add trackConsentWithdrawn method (close snowplow#630)

Author: mhadam

core/lib/core.ts

@@ -878,6 +878,45 @@ export function trackerCore(base64: boolean, callback?: (PayloadData) => void) {
 					pageResults: pageResults
 				})
 			}, context, tstamp);
+		},
+
+		/**
+		 * Track a consent withdrawn event
+		 *
+		 * @param {boolean} all - Indicates user withdraws consent for all documents.
+		 * @param {number} [id] - ID number associated with document.
+		 * @param {number} [version] - Version number of document.
+		 * @param {string} [name] - Name of document.
+		 * @param {string} [description] - Description of document.
+		 * @param {Array<SelfDescribingJson>} [context] - Context relating to the event.
+		 * @param {Timestamp} [tstamp] - TrackerTimestamp of the event.
+		 * @return Payload
+		 */
+		trackConsentWithdrawn: function(
+			all: boolean,
+			id?: number,
+			version?: number,
+			name?: string,
+			description?: string,
+			context?: Array<SelfDescribingJson>,
+			tstamp?: Timestamp): PayloadData {
+
+			let documentJson = {
+				schema: 'iglu:com.snowplowanalytics.snowplow/consent_document/jsonschema/1-0-0',
+				data: removeEmptyProperties({
+					id: id,
+					version: version,
+					name: name,
+					description: description
+				})
+			};
+
+			return trackSelfDescribingEvent({
+				schema: 'iglu:com.snowplowanalytics.snowplow/consent_withdrawn/jsonschema/1-0-0',
+				data: removeEmptyProperties({
+					all: all
+				})
+			}, documentJson.data && context ? context.concat([documentJson]) : context, tstamp);
 		}
 	};
 }

core/tests/unit/core.js

@@ -491,6 +491,42 @@ define([
 			compare(tracker.trackSiteSearch(terms, filters, totalResults, pageResults), expected);
 		},
 
+		"Track a consent withdrawn event": function () {
+			var all = false;
+			var id = 1234;
+			var version = 2;
+			var name = "consent_form";
+			var description = "user withdraws consent for form";
+			var tstamp = 1000000000000;
+			var inputContext = [{
+				schema: 'iglu:com.snowplowanalytics.snowplow/consent_document/jsonschema/1-0-0',
+				data: {
+					id: id,
+					version: version,
+					name: name,
+					description: description
+				}
+			}];
+			var inputJson = {
+				schema: 'iglu:com.snowplowanalytics.snowplow/consent_withdrawn/jsonschema/1-0-0',
+				data: {
+					all: all
+				}
+			};
+			var expected = {
+				e: 'ue',
+				ue_pr: JSON.stringify({
+					schema: unstructEventSchema,
+					data: inputJson
+				}),
+				co: JSON.stringify({
+					schema: 'iglu:com.snowplowanalytics.snowplow/contexts/jsonschema/1-0-0',
+					data: inputContext
+				})
+			};
+			compare(tracker.trackConsentWithdrawn(all, id, version, name, description, [], tstamp), expected);
+		},
+
 		"Track a page view with custom context": function () {
 			var url = 'http://www.example.com';
 			var page = 'title page';