From 4e4929b0cdadb59329192ad4e62908bef17247e0 Mon Sep 17 00:00:00 2001
From: Matt Wheatley <terrawheat@gmail.com>
Date: Wed, 3 Feb 2016 12:42:44 +0000
Subject: [PATCH] Definitions for the Service provided by
 angular-google-analytics

Current type definitions only provided for the AnalyticsProvider used
for configuring the service. This adds some of the common properties
of the service that can be injected in to controllers.
---
 .../angular-google-analytics-service.d.ts     | 62 +++++++++++++++++++
 .../angular-google-analytics-tests.ts         | 39 ++++++++++++
 2 files changed, 101 insertions(+)
 create mode 100644 angular-google-analytics/angular-google-analytics-service.d.ts

diff --git a/angular-google-analytics/angular-google-analytics-service.d.ts b/angular-google-analytics/angular-google-analytics-service.d.ts
new file mode 100644
index 0000000000..5f478621cb
--- /dev/null
+++ b/angular-google-analytics/angular-google-analytics-service.d.ts
@@ -0,0 +1,62 @@
+// Type definitions for angular-google-analytics v1.1.0
+// Project: https://github.com/revolunet/angular-google-analytics
+// Definitions by: Matt Wheatley <https://github.com/terrawheat>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module angular.google.analytics {
+  interface AnalyticsService {
+    /**
+     * @summary If logging is enabled then all outbound calls are accessible via an in-memory array.
+     * This is useful for troubleshooting and seeing the order of outbound calls with parameters.
+     */
+    log: Array<Object>;
+
+    /**
+     * @summary If in offline mode then all calls are queued to an in-memory array for future processing.
+     * All calls queued to the offlineQueue are not outbound calls yet and hence do not show up in the log.
+     */
+    offlineQueue: Array<Object>;
+
+    /**
+     * @summary Returns the current URL that would be sent if a `trackPage` call was made.
+     * @return {string} The URL
+     */
+    getUrl: () => string;
+
+    /**
+     * @summary Manually create classic analytics (ga.js) script tag
+     */
+    createScriptTag: () => void;
+
+    /**
+     * @summary Manually create universal analytics (analytics.js) script tag
+     */
+    createAnalyticsScriptTag: () => void;
+
+    /**
+     * @summary Allows for advanced configuration and definitions in univeral analytics only. This is a no-op when using classic analytics.
+     */
+    set: (key: string, value: any, accountName?: string) => void;
+
+    /**
+     * @summary Creates a new page view event
+     * @param  {string} pageURL URL of page view
+     * @param  {string} title Page Title
+     * @param  {Object}  dimensions Additional dimensions and metrics
+     */
+    trackPage: (pageURL: string, title?: string, dimensions?: { [expr: string]: any }) => void;
+
+    /**
+     * @summary Create a new event
+     */
+    trackEvent: (category: string, action: string, label: string, value?: any, nonInteractionFlag?: boolean, dimensions?: { [expr: string]: any }) => void;
+
+    trackException: (descrption: string, isFatal: boolean) => void;
+
+    /**
+     * @summary While in offline mode, no calls to the ga function or pushes to the gaq array are made.
+     * This will queue all calls for later sending once offline mode is reset to false.
+     */
+    offline: (offlineMode: boolean) => void;
+  }
+}
diff --git a/angular-google-analytics/angular-google-analytics-tests.ts b/angular-google-analytics/angular-google-analytics-tests.ts
index 9da39ba3c7..b8c40d64f5 100644
--- a/angular-google-analytics/angular-google-analytics-tests.ts
+++ b/angular-google-analytics/angular-google-analytics-tests.ts
@@ -1,4 +1,5 @@
 /// <reference path="angular-google-analytics.d.ts" />
+/// <reference path="angular-google-analytics-service.d.ts" />
 
 function ConfigurationMethodChaining(AnalyticsProvider: angular.google.analytics.AnalyticsProvider) {
     AnalyticsProvider
@@ -54,3 +55,41 @@ function SetRouteTrackingBehaviors(AnalyticsProvider: angular.google.analytics.A
     AnalyticsProvider.setPageEvent("$stateChangeSuccess");
     AnalyticsProvider.setRemoveRegExp(/\/\d+?$/);
 }
+
+function RetrieveCurrentURL(Analytics: angular.google.analytics.AnalyticsService) {
+    var test = Analytics.getUrl();
+}
+
+function ManualScriptTagInjection(Analytics: angular.google.analytics.AnalyticsService) {
+  Analytics.createScriptTag();
+  Analytics.createAnalyticsScriptTag();
+}
+
+function SetCustomDimensions(Analytics: angular.google.analytics.AnalyticsService) {
+  Analytics.set('&uid', 1234);
+  Analytics.set('dimension1', 'Paid');
+  Analytics.set('dimension2', 'Paid', 'accountName');
+}
+
+function PageTracking(Analytics: angular.google.analytics.AnalyticsService) {
+  Analytics.trackPage('/video/detail/XXX');
+  Analytics.trackPage('/video/detail/XXX', 'Video XXX');
+  Analytics.trackPage('/video/detail/XXX', 'Video XXX', { dimension15: 'My Custom Dimension', metric18: 8000 });
+}
+
+function EventTracking(Analytics: angular.google.analytics.AnalyticsService) {
+   Analytics.trackEvent('video', 'play', 'django.mp4');
+   Analytics.trackEvent('video', 'play', 'django.mp4', 4);
+   Analytics.trackEvent('video', 'play', 'django.mp4', 4, true);
+   Analytics.trackEvent('video', 'play', 'django.mp4', 4, true, { dimension15: 'My Custom Dimension', metric18: 8000 });
+}
+
+function ExceptionTracking(Analytics: angular.google.analytics.AnalyticsService) {
+  Analytics.trackException('Function "foo" is undefined on object "bar"', true);
+}
+
+function OfflineMode(Analytics: angular.google.analytics.AnalyticsService) {
+  Analytics.offline(true);
+  Analytics.offline(false);
+  Analytics.offlineQueue;
+}