@types/universal-analytics - npm Package Compare versions

Comparing version 0.3.27 to 0.4.0

universal-analytics/index.d.ts

@@ -1,92 +0,182 @@
-// Type definitions for universal-analytics v0.3.2
+// Type definitions for universal-analytics 0.4
 // Project: https://github.com/peaksandpies/universal-analytics
-// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
+// Definitions by: Bart van der Schoor <https://github.com/Bartvds>, Iker Pérez Brunelli <https://github.com/DarkerTV>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-interface UniversalAnalytics {
-    (accountID:string, uuid?:string, opts?:Object):UniversalAnalytics.Client;
-}
+declare namespace ua {
+    type Callback = (error: Error | null, count: number) => void;
 
-export = UniversalAnalytics;
+    interface VisitorOptions {
+        hostname?: string;
+        path?: string;
+        https?: boolean;
+        enableBatching?: boolean;
+        batchSize?: number;
+        tid?: string;
+        cid?: string;
+        uid?: string;
+        debug?: boolean;
+        strictCidFormat?: boolean;
+        requestOptions?: { [key: string]: any };
+        headers?: { [key: string]: string };
+    }
 
-declare namespace UniversalAnalytics {
+    interface MiddlewareOptions extends VisitorOptions {
+        cookieName?: string;
+    }
 
-    interface Client {
-        debug():UniversalAnalytics.Client;
+    interface PageviewParams {
+        dp?: string;
+        dh?: string;
+        dt?: string;
+        dl?: string;
+        [key: string]: any;
+    }
 
-        send():void;
+    interface ScreenviewParams {
+        cd?: string;
+        an?: string;
+        av?: string;
+        aid?: string;
+        aiid?: string;
+        [key: string]: any;
+    }
 
-        pageview(path:string):Client;
-        pageview(path:string, callback?:(err:any) => void):void;
-        pageview(params:Object):Client;
-        pageview(params:Object, callback?:(err:any) => void):void;
-        pageview(path:string, hostname:string):Client;
-        pageview(path:string, hostname:string, callback?:(err:any) => void):void;
-        pageview(path:string, title:string, hostname:string):Client;
-        pageview(path:string, title:string, hostname:string, callback?:(err:any) => void):void;
+    interface EventParams {
+        ec?: string;
+        ea?: string;
+        el?: string;
+        ev?: string | number;
+        p?: string;
+        dp?: string;
+        [key: string]: any;
+    }
 
+    interface TransactionParams {
+        ti?: string;
+        tr?: string | number;
+        ts?: string | number;
+        tt?: string | number;
+        ta?: string;
+        p?: string;
+        [key: string]: any;
+    }
 
-        event(category:string, action:string):Client;
-        event(category:string, action:string, callback?:(err:any) => void):void;
-        event(category:string, action:string, label:string):Client;
-        event(category:string, action:string, label:string, callback?:(err:any) => void):void;
-        event(category:string, action:string, label:string, value:any):Client;
-        event(category:string, action:string, label:string, value:any, callback?:(err:any) => void):void;
-        event(category:string, action:string, label:string, value:any, params:Object, callback?:(err:any) => void):void;
-        event(params:Object):Client;
-        event(params:Object, callback:(err:any) => void):void;
+    interface ItemParams {
+        ip?: string | number;
+        iq?: string | number;
+        ic?: string;
+        in?: string;
+        iv?: string;
+        p?: string;
+        ti?: string;
+        [key: string]: any;
+    }
 
+    interface ExceptionParams {
+        exd?: string;
+        exf?: boolean;
+        [key: string]: any;
+    }
 
-        transaction(id:string):Client;
-        transaction(id:string, callback:(err:any) => void):void;
-        transaction(id:string, revenue:number):Client;
-        transaction(id:string, revenue:number, callback:(err:any) => void):void;
-        transaction(id:string, revenue:number, shipping:number):Client;
-        transaction(id:string, revenue:number, shipping:number, callback:(err:any) => void):void;
-        transaction(id:string, revenue:number, shipping:number, taxping:number):Client;
-        transaction(id:string, revenue:number, shipping:number, taxping:number, callback:(err:any) => void):void;
-        transaction(id:string, revenue:number, shipping:number, taxping:number, affiliation:string):Client;
-        transaction(id:string, revenue:number, shipping:number, taxping:number, affiliation:string, callback:(err:any) => void):void;
-        transaction(params:Object):Client;
-        transaction(params:Object, callback:(err:any) => void):void;
+    interface TimingParams {
+        utc?: string;
+        utv?: string;
+        utt?: string | number;
+        utl?: string;
+        [key: string]: any;
+    }
 
+    interface Session {
+        cid?: string;
+    }
 
-        item(price:number):Client;
-        item(price:number, callback:(err:any) => void):void;
-        item(price:number, quantity:number):Client;
-        item(price:number, quantity:number, callback:(err:any) => void):void;
-        item(price:number, quantity:number, sku:number):Client;
-        item(price:number, quantity:number, sku:number, callback:(err:any) => void):void;
-        item(price:number, quantity:number, sku:number, name:string):Client;
-        item(price:number, quantity:number, sku:number, name:string, callback:(err:any) => void):void;
-        item(price:number, quantity:number, sku:number, name:string, variation:string):Client;
-        item(price:number, quantity:number, sku:number, name:string, variation:string, callback:(err:any) => void):void;
-        item(price:number, quantity:number, sku:number, name:string, variation:string, params:Object):Client;
-        item(price:number, quantity:number, sku:number, name:string, variation:string, params:Object, callback:(err:any) => void):void;
-        item(params:Object):Client;
-        item(params:Object, callback:(err:any) => void):void;
+    class Visitor {
+        constructor(accountID: VisitorOptions | string);
+        constructor(accountID: string, uuid: VisitorOptions | string, context?: { [key: string]: any }, persistentParams?: { [key: string]: any });
 
+        debug(debug?: boolean): Visitor;
 
-        exception(description:string):Client;
-        exception(description:string, callback:(err:any) => void):void;
-        exception(description:string, fatal:boolean):Client;
-        exception(description:string, fatal:boolean, callback:(err:any) => void):void;
-        exception(params:Object):Client;
-        exception(params:Object, callback:(err:any) => void):void;
+        reset(): Visitor;
 
+        set(key: string | number, value: any): void;
 
-        timing(category:string):Client;
-        timing(category:string, callback:(err:any) => void):void;
-        timing(category:string, variable:string):Client;
-        timing(category:string, variable:string, callback:(err:any) => void):void;
-        timing(category:string, variable:string, time:number):Client;
-        timing(category:string, variable:string, time:number, callback:(err:any) => void):void;
-        timing(category:string, variable:string, time:number, label:string):Client;
-        timing(category:string, variable:string, time:number, label:string, callback:(err:any) => void):void;
-        timing(params:Object):Client;
-        timing(params:Object, callback:(err:any) => void):void;
+        pageview(path: PageviewParams | string, callback?: Callback): Visitor;
+        pageview(path: string, hostname: string, callback?: Callback): Visitor;
+        pageview(path: string, hostname: string, title: string, callback?: Callback): Visitor;
+        pageview(path: string, hostname: string, title: string, params: PageviewParams, callback?: Callback): Visitor;
 
+        pv(path: PageviewParams | string, callback?: Callback): Visitor;
+        pv(path: string, hostname: string, callback?: Callback): Visitor;
+        pv(path: string, hostname: string, title: string, callback?: Callback): Visitor;
+        pv(path: string, hostname: string, title: string, params: PageviewParams, callback?: Callback): Visitor;
 
-        middleware(accountID:string, options?:any):any;
+        screenview(params: ScreenviewParams, callback?: Callback): Visitor;
+        screenview(screenName: string, appName: string, callback?: Callback): Visitor;
+        screenview(screenName: string, appName: string, appVersion: string, callback?: Callback): Visitor;
+        screenview(screenName: string, appName: string, appVersion: string, appId: string, callback?: Callback): Visitor;
+        screenview(screenName: string, appName: string, appVersion: string, appId: string, appInstallerId: string, callback?: Callback): Visitor;
+        screenview(screenName: string, appName: string, appVersion: string, appId: string, appInstallerId: string, params: ScreenviewParams, callback?: Callback): Visitor;
+
+        event(params: EventParams, callback?: Callback): Visitor;
+        event(category: string, action: string, callback?: Callback): Visitor;
+        event(category: string, action: string, label: string, callback?: Callback): Visitor;
+        event(category: string, action: string, label: string, value: string | number, callback?: Callback): Visitor;
+        event(category: string, action: string, label: string, value: string | number, params: EventParams, callback?: Callback): Visitor;
+
+        e(params: EventParams, callback?: Callback): Visitor;
+        e(category: string, action: string, callback?: Callback): Visitor;
+        e(category: string, action: string, label: string, callback?: Callback): Visitor;
+        e(category: string, action: string, label: string, value: string | number, callback?: Callback): Visitor;
+        e(category: string, action: string, label: string, value: string | number, params: EventParams, callback?: Callback): Visitor;
+
+        transaction(id: TransactionParams | string, callback?: Callback): Visitor;
+        transaction(id: string, revenue: string | number, callback?: Callback): Visitor;
+        transaction(id: string, revenue: string | number, shipping: string | number, callback?: Callback): Visitor;
+        transaction(id: string, revenue: string | number, shipping: string | number, tax: string | number, callback?: Callback): Visitor;
+        transaction(id: string, revenue: string | number, shipping: string | number, tax: string | number, affiliation: string, callback?: Callback): Visitor;
+        transaction(id: string, revenue: string | number, shipping: string | number, tax: string | number, affiliation: string, params: TransactionParams, callback?: Callback): Visitor;
+
+        t(id: TransactionParams | string, callback?: Callback): Visitor;
+        t(id: string, revenue: string | number, callback?: Callback): Visitor;
+        t(id: string, revenue: string | number, shipping: string | number, callback?: Callback): Visitor;
+        t(id: string, revenue: string | number, shipping: string | number, tax: string | number, callback?: Callback): Visitor;
+        t(id: string, revenue: string | number, shipping: string | number, tax: string | number, affiliation: string, callback?: Callback): Visitor;
+        t(id: string, revenue: string | number, shipping: string | number, tax: string | number, affiliation: string, params: TransactionParams, callback?: Callback): Visitor;
+
+        item(price: ItemParams | string | number, callback?: Callback): Visitor;
+        item(price: string | number, quantity: string | number, callback?: Callback): Visitor;
+        item(price: string | number, quantity: string | number, sku: string, callback?: Callback): Visitor;
+        item(price: string | number, quantity: string | number, sku: string, name: string, callback?: Callback): Visitor;
+        item(price: string | number, quantity: string | number, sku: string, name: string, variation: string, callback?: Callback): Visitor;
+        item(price: string | number, quantity: string | number, sku: string, name: string, variation: string, params: ItemParams, callback?: Callback): Visitor;
+
+        i(price: ItemParams | string | number, callback?: Callback): Visitor;
+        i(price: string | number, quantity: string | number, callback?: Callback): Visitor;
+        i(price: string | number, quantity: string | number, sku: string, callback?: Callback): Visitor;
+        i(price: string | number, quantity: string | number, sku: string, name: string, callback?: Callback): Visitor;
+        i(price: string | number, quantity: string | number, sku: string, name: string, variation: string, callback?: Callback): Visitor;
+        i(price: string | number, quantity: string | number, sku: string, name: string, variation: string, params: ItemParams, callback?: Callback): Visitor;
+
+        exception(description: ExceptionParams | string, callback?: Callback): Visitor;
+        exception(description: string, fatal: boolean, callback?: Callback): Visitor;
+        exception(description: string, fatal: boolean, params: ExceptionParams, callback?: Callback): Visitor;
+
+        timing(category: TimingParams | string, callback?: Callback): Visitor;
+        timing(category: string, variable: string, callback?: Callback): Visitor;
+        timing(category: string, variable: string, time: string | number, callback?: Callback): Visitor;
+        timing(category: string, variable: string, time: string | number, label: string, callback?: Callback): Visitor;
+        timing(category: string, variable: string, time: string | number, label: string, params: TimingParams, callback?: Callback): Visitor;
+
+        send(fn?: (error: any, response: any, body: any) => void): void;
     }
+
+    function createFromSession(session?: Session): Visitor;
+
+    function middleware(tid: string, options?: ua.MiddlewareOptions): (req: any, res: any, next: (err: any) => void) => void;
 }
+
+declare function ua(accountID: ua.VisitorOptions | string): ua.Visitor;
+declare function ua(accountID: string, uuid: ua.VisitorOptions | string): ua.Visitor;
+declare function ua(accountID: string, uuid: string, options: ua.VisitorOptions): ua.Visitor;
+export = ua;

universal-analytics/package.json

 {
     "name": "@types/universal-analytics",
-    "version": "0.3.27",
-    "description": "TypeScript definitions for universal-analytics v0.3.2",
+    "version": "0.4.0",
+    "description": "TypeScript definitions for universal-analytics",
     "license": "MIT",
-    "author": "Bart van der Schoor <https://github.com/Bartvds>",
+    "contributors": [
+        {
+            "name": "Bart van der Schoor",
+            "url": "https://github.com/Bartvds"
+        },
+        {
+            "name": "Iker Pérez Brunelli",
+            "url": "https://github.com/DarkerTV"
+        }
+    ],
     "main": "",
@@ -14,4 +23,5 @@ "repository": {
     "dependencies": {},
-    "typings": "index.d.ts",
-    "typesPublisherContentHash": "9693a600b8f2453b6398d1ed67c6f0641ea3c5fd3dbe5ebb6755a954bf38e170"
+    "peerDependencies": {},
+    "typesPublisherContentHash": "ba3aab472c3c59d88c84bcb7d7c3a1d2ff38d6141fd2a191b12537c29c4f84c0",
+    "typeScriptVersion": "2.0"
 }

universal-analytics/README.md

@@ -5,15 +5,13 @@ # Installation
 # Summary
-This package contains type definitions for universal-analytics v0.3.2 (https://github.com/peaksandpies/universal-analytics).
+This package contains type definitions for universal-analytics (https://github.com/peaksandpies/universal-analytics).
 
 # Details
-Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/universal-analytics
+Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/universal-analytics
 
 Additional Details
- * Last updated: Mon, 19 Sep 2016 17:28:59 GMT
- * File structure: ProperModule
- * Library Dependencies: none
- * Module Dependencies: none
+ * Last updated: Fri, 02 Jun 2017 13:55:42 GMT
+ * Dependencies: none
  * Global values: none
 
 # Credits
-These definitions were written by Bart van der Schoor <https://github.com/Bartvds>.
+These definitions were written by Bart van der Schoor <https://github.com/Bartvds>, Iker Pérez Brunelli <https://github.com/DarkerTV>.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11888

increased by71.37%

Lines of code

152

increased by58.33%

Worsened metrics

Number of lines in readme file

17

decreased by-10.53%

No dependency changes