Add tests and additional definitions

segment-analytics/segment-analytics.d.ts

@@ -3,37 +3,35 @@
 // Definitions by: Andrew Fong <https://github.com/fongandrew>
 // Definitions: https://github.com/borisyankov/DefinitelyTyped
 
+/// <reference path="../jquery/jquery.d.ts" />
+
 declare module SegmentAnalytics {
 
   // Generic options object with integrations
-  interface SegmentOpts<Integrations> {
-    integrations?: Integrations;
+  interface SegmentOpts {
+    integrations?: any;
     anonymousId?: string;
-  };
+  }
 
   // The actual analytics.js object
-  interface AnalyticsJS<Integrations> {
+  interface AnalyticsJS {
 
     /* Configure Segment with write key */
     load(writeKey: string);
 
     /* The identify method is how you tie one of your users and their actions
        to a recognizable userId and traits. */
-    identify(userId: string, traits?: Object,
-             options?: SegmentOpts<Integrations>,
+    identify(userId: string, traits?: Object, options?: SegmentOpts,
              callback?: () => void): void;
     identify(userId: string, traits: Object, callback?: () => void): void;
     identify(userId: string, callback?: () => void): void;
-    identify(traits?: Object,
-             options?: SegmentOpts<Integrations>,
-             callback?: () => void): void;
-    identify(traits?: Object,
+    identify(traits?: Object, options?: SegmentOpts,
              callback?: () => void): void;
+    identify(traits?: Object, callback?: () => void): void;
     identify(callback: () => void): void;
 
     /* The track method lets you record any actions your users perform. */
-    track(event: string, properties?: Object,
-          options?: SegmentOpts<Integrations>,
+    track(event: string, properties?: Object, options?: SegmentOpts,
           callback?: () => void): void;
     track(event: string, properties?: Object,
           callback?: () => void): void;
@@ -42,23 +40,19 @@ declare module SegmentAnalytics {
     /* The page method lets you record page views on your website, along with
        optional extra information about the page being viewed. */
     page(category: string, name: string, properties?: Object,
-         options?: SegmentOpts<Integrations>,
-         callback?: () => void): void;
+         options?: SegmentOpts, callback?: () => void): void;
     page(name?: string, properties?: Object,
-         options?: SegmentOpts<Integrations>,
-         callback?: () => void): void;
+         options?: SegmentOpts, callback?: () => void): void;
     page(name?: string, properties?: Object, callback?: () => void): void;
     page(name?: string, callback?: () => void): void;
-    page(properties?: Object,
-         options?: SegmentOpts<Integrations>,
+    page(properties?: Object, options?: SegmentOpts,
          callback?: () => void): void;
     page(callback?: () => void): void;
 
     /* The group method associates an individual user with a group. The group
-       can a company, organization, account, project, team or any other name 
+       can a company, organization, account, project, team or any other name
        you came up with for the same concept. */
-    group(groupId: string, traits?: Object,
-          options?: SegemntOpts<Integrations>,
+    group(groupId: string, traits?: Object, options?: SegmentOpts,
           callback?: () => void): void;
     group(groupId: string, traits?: Object, callback?: () => void): void;
     group(groupId: string, callback?: () => void): void;
@@ -70,39 +64,69 @@ declare module SegmentAnalytics {
        Some providers also don’t alias automatically for you when an anonymous
        user signs up (like Mixpanel), so you need to call alias manually right
        after sign up with their brand new userId. */
-    alias(userId: string, previousId?: string,
-          options?: SegmentOpts<Integrations>,
+    alias(userId: string, previousId?: string, options?: SegmentOpts,
           callback?: () => void): void;
     alias(userId: string, previousId?: string, callback?: () => void): void;
     alias(userId: string, callback?: () => void): void;
-    alias(userId: string, options?: SegmentOpts<Integrations>,
-          callback?: () => void): void;
+    alias(userId: string, options?: SegmentOpts, callback?: () => void): void;
 
     /* trackLink is a helper that binds a track call to whenever a link is
        clicked. Usually the page would change before you could call track, but
        with trackLink a small timeout is inserted to give the track call enough
        time to fire. */
-    trackLink(elements: Element|Element[], event: string, properties?: Object);
+    trackLink(elements: JQuery|Element[]|Element,
+              event: string|{ (elm: Element): string },
+              properties?: Object|{ (elm: Element): Object });
 
     /* trackForm is a helper that binds a track call to a form submission.
        Usually the page would change before you could call track, but with
        trackForm a small timeout is inserted to give the track call enough
        time to fire. */
-    trackForm(elements: Element|Element[], event: string, properties?: Object);
+    trackForm(elements: JQuery|Element[]|Element,
+              event: string|{ (Element): string },
+              properties?: Object|{ (elm: Element): Object });
 
     /* The ready method allows you to pass in a callback that will be called as
        soon as all of your enabled integrations have loaded. It’s like jQuery’s
        ready method, except for integrations. */
     ready(callback: () => void);
 
-    // Cookie-based user object
+    /* If you need to clear the user and group id and traits we’ve added a
+       reset function that is most commonly used when your identified users
+       logout of your application. */
+    reset();
+
+    /* Once Analytics.js loaded, you can retrieve information about the
+       currently identified user or group like their id and traits. */
     user(): {
       id(): string;
       logout(): void;
       reset(): void;
       anonymousId(newId?: string): string;
-    };
+      traits(newTraits?: Object): void;
+    }
+
+    group(): {
+      id(): string;
+      traits(newTraits?: Object): void;
+    }
+
+    /* Analytics.js has a debug mode that logs helpful messages to the
+       console. */
+    debug(state?: boolean): void;
+
+    /* The global analytics object emits events whenever you call alias, group,
+       identify, track or page. That way you can listen to those events and run
+       your own custom code. */
+    on(event: string,
+       callback: {
+        (event: string, properties: Object, options: SegmentOpts): void
+      });
+
+    /* You can extend the length (in milliseconds) of the method callbacks and
+       helpers */
+    timeout(milliseconds: number);
   }
 }
 
-declare var analytics: SegmentAnalytics.AnalyticsJS<any>;
+declare var analytics: SegmentAnalytics.AnalyticsJS;