From 1f0b864b9d63574481c8ab39c84ca8378a6dce9c Mon Sep 17 00:00:00 2001 From: Guilherme Bernal Date: Mon, 25 May 2015 00:17:41 -0300 Subject: [PATCH] Add definitions for the Piwik NodeJS tracker Piwik.org is a tracker similar to Google Analitics, but can run on your own server. These definitions are for the node api. --- piwik-tracker/piwik-tracker.d.ts | 91 ++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 piwik-tracker/piwik-tracker.d.ts diff --git a/piwik-tracker/piwik-tracker.d.ts b/piwik-tracker/piwik-tracker.d.ts new file mode 100644 index 000000000..a1c18b627 --- /dev/null +++ b/piwik-tracker/piwik-tracker.d.ts @@ -0,0 +1,91 @@ +// Type definitions for PiwikTracker v0.1.1 +// Project: http://piwik.org - https://www.npmjs.com/package/piwik-tracker +// Definitions by: Guilherme Bernal +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +declare module "piwik-tracker" { + + export = PiwikTracker; + + // refer to http://developer.piwik.org/api-reference/tracking-api + interface PiwikTrackOptions { + // Required parameters + url : string; + + // Recommended parameters + action_name? : string; + _id? : string; + rand? : string; + apiv? : number; + + // Optional User info + urlref? : string; + _cvar? : string; + _idvc? : string; + _viewts? : string; + _idts? : string; + _rcn? : string; + _rck? : string; + res? : string; + h? : number; + m? : number; + s? : number; + ua? : string; + lang? : string; + uid? : string; + cid? : string; + new_visit? : number; + + // Optional Action info + cvar? : string; + link? : string; + download? : string; + search? : string; + search_cat? : string; + search_count? : number; + idgoal? : number; + revenue? : number; + gt_ms? : number; + cs? : string; + + // Optional Event Tracking info + e_c? : string; + e_a? : string; + e_n? : string; + e_v? : string; + + // Optional Content Tracking info + c_n? : string; + c_p? : string; + c_t? : string; + c_i? : string; + + // Optional Ecommerce info + ec_id? : string; + ec_items? : string; + ec_st? : number; + ec_tx? : number; + ec_sh? : number; + ec_dt? : number; + _ects? : number; + + // Other parameters (require authentication via token_auth) + token_auth? : string; + cip? : string; + cdt? : string; + country? : string; + region? : string; + city? : string; + lat? : string; + long? : string; + + // Other parameters + send_image? : number; + } + + class PiwikTracker { + constructor(siteId : number, trackerUrl : string); + track(options : PiwikTrackOptions) : void; + } + +}