2.0.11

.gitlab-ci.yml

@@ -15,7 +15,9 @@ stages:
 testLEGACY:
   stage: test
   script:
-    - npmci test legacy
+    - npmci node install lts
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -24,7 +26,9 @@ testLEGACY:
 testLTS:
   stage: test
   script:
-    - npmci test lts
+    - npmci node install lts
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -32,7 +36,9 @@ testLTS:
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -40,7 +46,8 @@ testSTABLE:
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci npm prepare
+    - npmci npm publish
   only:
     - tags
   tags:

README.md

@@ -22,23 +22,36 @@ Google Analytics everywhere
 Use TypeScript for best in class instellisense.
 
 ### Why does this package exist?
-Tracking users in webapps is common. We use Google Analytics to gain insight in who is using what
+Tracking users in webapps is common, often to gain insight in who is using what and where to spend dev resources for best efficiency.
-and where to spend resources for best efficiency.
 
 Doing the same stuff in apps can be a bit of a hassle.
 Unnecessary dependencies used by many existing analytics tools make the whole app slow
 just to gain a little usage info.
-Say hello to smartanalytics.
+
-It features a very slim dependency tree using the native node request module to send posts to Google Analytics.
+**Say hello to smartanalytics. :)**
+It features a very slim dependency tree using the native node request module to send posts to a tracking API of your choice.
 
 ### How do I use this package?
 
 ```javascript
-import {AnalyticsAccount} from 'smartanalytics'
+import { Analytics } from 'smartanalytics'
-let myAnalyticsAccount = new AnalyticsAccount('My App Name', 'UA-XXXXXX-Y')
+let myAnalytics = new plugins.smartanalytics.Analytics({
-myAnalyticsAccount.sendEvent('npmtool', 'install', 'somelabel')
+  apiEndPoint: 'https://somepubapi.endpoint.com',
+  projectId: 'gitzone',
+  appName: 'npmts'
+})
+
+myAnalytics.recordEvent('someEvent', {
+    myKey1: 'myValue1',
+    myKey2: 'myValue2',
+    myDataKey3: 3
+  }).catch(err => {
+    console.log(err)
+  })
 ```
 
+
+
 For further information read the linked docs at the top of this README.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

dist/smartanalytics.classes.analytics.d.ts

@@ -4,10 +4,10 @@ export declare class Analytics {
     apiEndPoint: string;
     secretKey: string;
     constructor(optionsArg: {
-        projectIdArg: string;
+        projectId: string;
-        appNameArg: string;
+        appName: string;
-        apiEndPointArg: string;
+        apiEndPoint: string;
-        secretKeyArg?: string;
+        secretKey?: string;
     });
-    recordEvent(identifierArg: string, analyticsDataArg: any): Promise<void>;
+    recordEvent(eventIdArg: string, analyticsDataArg: any): Promise<void>;
 }

dist/smartanalytics.classes.analytics.js

@@ -12,19 +12,19 @@ const plugins = require("./smartanalytics.plugins");
 class Analytics {
     constructor(optionsArg) {
         this.secretKey = '';
-        this.projectId = optionsArg.projectIdArg;
+        this.projectId = optionsArg.projectId;
-        this.appName = optionsArg.appNameArg;
+        this.appName = optionsArg.appName;
-        this.apiEndPoint = optionsArg.apiEndPointArg;
+        this.apiEndPoint = optionsArg.apiEndPoint;
-        if (optionsArg.secretKeyArg) {
+        if (optionsArg.secretKey) {
-            this.secretKey = optionsArg.secretKeyArg;
+            this.secretKey = optionsArg.secretKey;
         }
     }
-    recordEvent(identifierArg, analyticsDataArg) {
+    recordEvent(eventIdArg, analyticsDataArg) {
         return __awaiter(this, void 0, void 0, function* () {
             let dataToSend = {
                 projectId: this.projectId,
                 appName: this.appName,
-                identifier: identifierArg,
+                eventId: eventIdArg,
                 analyticsData: analyticsDataArg
             };
             yield plugins.smartrequest.post(this.apiEndPoint, {
@@ -40,4 +40,4 @@ class Analytics {
     }
 }
 exports.Analytics = Analytics;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhbmFseXRpY3MuY2xhc3Nlcy5hbmFseXRpY3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFuYWx5dGljcy5jbGFzc2VzLmFuYWx5dGljcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBQUEsb0RBQW1EO0FBRW5EO0lBS0UsWUFBYSxVQUtaO1FBTkQsY0FBUyxHQUFXLEVBQUUsQ0FBQTtRQU9wQixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxZQUFZLENBQUE7UUFDeEMsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUMsVUFBVSxDQUFBO1FBQ3BDLElBQUksQ0FBQyxXQUFXLEdBQUcsVUFBVSxDQUFDLGNBQWMsQ0FBQTtRQUM1QyxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQztZQUM1QixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxZQUFZLENBQUE7UUFDMUMsQ0FBQztJQUNILENBQUM7SUFFSyxXQUFXLENBQUUsYUFBcUIsRUFBRSxnQkFBcUI7O1lBQzdELElBQUksVUFBVSxHQUFHO2dCQUNmLFNBQVMsRUFBRSxJQUFJLENBQUMsU0FBUztnQkFDekIsT0FBTyxFQUFFLElBQUksQ0FBQyxPQUFPO2dCQUNyQixVQUFVLEVBQUUsYUFBYTtnQkFDekIsYUFBYSxFQUFFLGdCQUFnQjthQUNoQyxDQUFBO1lBQ0QsTUFBTSxPQUFPLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFO2dCQUNoRCxPQUFPLEVBQUU7b0JBQ1AsY0FBYyxFQUFFLElBQUksQ0FBQyxTQUFTO29CQUM5QixjQUFjLEVBQUUsa0JBQWtCO2lCQUNuQztnQkFDRCxXQUFXLEVBQUUsVUFBVTthQUN4QixDQUFDLENBQUMsS0FBSyxDQUFDLEdBQUc7Z0JBQ1YsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUNsQixDQUFDLENBQUMsQ0FBQTtRQUNKLENBQUM7S0FBQTtDQUNGO0FBcENELDhCQW9DQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhbmFseXRpY3MuY2xhc3Nlcy5hbmFseXRpY3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFuYWx5dGljcy5jbGFzc2VzLmFuYWx5dGljcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBQUEsb0RBQW1EO0FBRW5EO0lBS0UsWUFBYSxVQUtaO1FBTkQsY0FBUyxHQUFXLEVBQUUsQ0FBQTtRQU9wQixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxTQUFTLENBQUE7UUFDckMsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFBO1FBQ2pDLElBQUksQ0FBQyxXQUFXLEdBQUcsVUFBVSxDQUFDLFdBQVcsQ0FBQTtRQUN6QyxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztZQUN6QixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxTQUFTLENBQUE7UUFDdkMsQ0FBQztJQUNILENBQUM7SUFFSyxXQUFXLENBQUUsVUFBa0IsRUFBRSxnQkFBcUI7O1lBQzFELElBQUksVUFBVSxHQUFHO2dCQUNmLFNBQVMsRUFBRSxJQUFJLENBQUMsU0FBUztnQkFDekIsT0FBTyxFQUFFLElBQUksQ0FBQyxPQUFPO2dCQUNyQixPQUFPLEVBQUUsVUFBVTtnQkFDbkIsYUFBYSxFQUFFLGdCQUFnQjthQUNoQyxDQUFBO1lBQ0QsTUFBTSxPQUFPLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFO2dCQUNoRCxPQUFPLEVBQUU7b0JBQ1AsY0FBYyxFQUFFLElBQUksQ0FBQyxTQUFTO29CQUM5QixjQUFjLEVBQUUsa0JBQWtCO2lCQUNuQztnQkFDRCxXQUFXLEVBQUUsVUFBVTthQUN4QixDQUFDLENBQUMsS0FBSyxDQUFDLEdBQUc7Z0JBQ1YsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUNsQixDQUFDLENBQUMsQ0FBQTtRQUNKLENBQUM7S0FBQTtDQUNGO0FBcENELDhCQW9DQyJ9

docs/index.md

@@ -0,0 +1,59 @@
+# smartanalytics
+Google Analytics everywhere
+
+## Availabililty
+[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartanalytics)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartanalytics)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartanalytics)
+[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartanalytics/)
+
+## Status for master
+[![build status](https://GitLab.com/pushrocks/smartanalytics/badges/master/build.svg)](https://GitLab.com/pushrocks/smartanalytics/commits/master)
+[![coverage report](https://GitLab.com/pushrocks/smartanalytics/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartanalytics/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/smartanalytics.svg)](https://www.npmjs.com/package/smartanalytics)
+[![Dependency Status](https://david-dm.org/pushrocks/smartanalytics.svg)](https://david-dm.org/pushrocks/smartanalytics)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartanalytics/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartanalytics/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/smartanalytics/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartanalytics)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+## Usage
+Use TypeScript for best in class instellisense.
+
+### Why does this package exist?
+Tracking users in webapps is common, often to gain insight in who is using what and where to spend dev resources for best efficiency.
+
+Doing the same stuff in apps can be a bit of a hassle.
+Unnecessary dependencies used by many existing analytics tools make the whole app slow
+just to gain a little usage info.
+
+**Say hello to smartanalytics. :)**
+It features a very slim dependency tree using the native node request module to send posts to a tracking API of your choice.
+
+### How do I use this package?
+
+```javascript
+import { Analytics } from 'smartanalytics'
+let myAnalytics = new plugins.smartanalytics.Analytics({
+  apiEndPoint: 'https://somepubapi.endpoint.com',
+  projectId: 'gitzone',
+  appName: 'npmts'
+})
+
+myAnalytics.recordEvent('someEvent', {
+    myKey1: 'myValue1',
+    myKey2: 'myValue2',
+    myDataKey3: 3
+  }).catch(err => {
+    console.log(err)
+  })
+```
+
+
+
+For further information read the linked docs at the top of this README.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

license

@@ -0,0 +1,19 @@
+Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

npmextra.json

@@ -1,10 +1,8 @@
 {
   "npmts": {
-    "coverageTreshold": 40
   },
   "npmci": {
-    "globalNpmTools": [
+    "npmGlobalTools": [],
-      "npmts"
+    "npmAccessLevel": "public"
-    ]
   }
 }

package.json

@@ -1,20 +1,24 @@
 {
-  "name": "smartanalytics",
+  "name": "@pushrocks/smartanalytics",
-  "version": "2.0.4",
+  "version": "2.0.11",
   "description": "Google Analytics everywhere",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)"
   },
-  "author": "",
+  "author": "Lossless GmbH",
   "license": "MIT",
   "dependencies": {
-    "smartq": "^1.1.1",
+    "@pushrocks/smartpromise": "^2.0.5",
-    "smartrequest": "^1.0.4",
+    "@pushrocks/smartrequest": "^1.1.14"
-    "typings-global": "^1.0.14"
   },
   "devDependencies": {
-    "tapbundle": "^1.1.1"
+    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tstest": "^1.0.15",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^10.12.0",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.15.0"
   }
 }

test/test.ts

@@ -1,27 +1,27 @@
-import { expect, tap } from 'tapbundle'
+import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smartanalytics from '../ts/index'
+import * as smartanalytics from '../ts/index';
 
-let testAnalytics: smartanalytics.Analytics
+let testAnalytics: smartanalytics.Analytics;
 
 tap.test('should create a valid AnalyticsAccount', async () => {
   testAnalytics = new smartanalytics.Analytics({
-    projectIdArg: 'sandbox',
+    projectId: 'sandbox',
-    appNameArg: 'smartanalytics',
+    appName: 'smartanalytics',
-    apiEndPointArg: 'https://pubapi-1.lossless.one/analytics'
+    apiEndPoint: 'https://pubapi.lossless.one/analytics'
-  })
+  });
-})
+});
 
 tap.test('should send a request to Lossless API endpoint', async () => {
   let doit = async () => {
     await testAnalytics.recordEvent('sandbox', {
       trackingPurpose: 'test'
-    })
+    });
     await testAnalytics.recordEvent('sandbox', {
       someValue: 'someData'
-    })
+    });
-  }
+  };
-  doit()
+  doit();
-})
+});
 
-tap.start()
+tap.start();

ts/index.ts

@@ -1 +1 @@
-export { Analytics } from './smartanalytics.classes.analytics'
+export { Analytics } from './smartanalytics.classes.analytics';

ts/smartanalytics.classes.analytics.ts

@@ -1,39 +1,41 @@
-import * as plugins from './smartanalytics.plugins'
+import * as plugins from './smartanalytics.plugins';
 
 export class Analytics {
-  projectId: string
+  public projectId: string;
-  appName: string
+  public appName: string;
-  apiEndPoint: string
+  public apiEndPoint: string;
-  secretKey: string = ''
+  public secretKey: string = '';
   constructor(optionsArg: {
-    projectIdArg: string
+    projectId: string;
-    appNameArg: string
+    appName: string;
-    apiEndPointArg: string
+    apiEndPoint: string;
-    secretKeyArg?: string
+    secretKey?: string;
   }) {
-    this.projectId = optionsArg.projectIdArg
+    this.projectId = optionsArg.projectId;
-    this.appName = optionsArg.appNameArg
+    this.appName = optionsArg.appName;
-    this.apiEndPoint = optionsArg.apiEndPointArg
+    this.apiEndPoint = optionsArg.apiEndPoint;
-    if (optionsArg.secretKeyArg) {
+    if (optionsArg.secretKey) {
-      this.secretKey = optionsArg.secretKeyArg
+      this.secretKey = optionsArg.secretKey;
     }
   }
 
-  async recordEvent (identifierArg: string, analyticsDataArg: any) {
+  async recordEvent(eventIdArg: string, analyticsDataArg: any) {
     let dataToSend = {
       projectId: this.projectId,
       appName: this.appName,
-      identifier: identifierArg,
+      eventId: eventIdArg,
       analyticsData: analyticsDataArg
-    }
+    };
-    await plugins.smartrequest.post(this.apiEndPoint, {
+    await plugins.smartrequest
+      .postJson(this.apiEndPoint, {
         headers: {
-        'authenticate': this.secretKey,
+          authenticate: this.secretKey,
           'Content-Type': 'application/json'
         },
         requestBody: dataToSend
-    }).catch(err => {
-      console.log(err)
       })
+      .catch(err => {
+        console.log(err);
+      });
   }
 }

ts/smartanalytics.plugins.ts

@@ -1,8 +1,7 @@
-import 'typings-global'
+import * as smartrequest from '@pushrocks/smartrequest';
-import * as smartrequest from 'smartrequest'
+import * as smartpromise from '@pushrocks/smartpromise';
-import * as smartq from 'smartq'
 
 export {
     smartrequest,
-    smartq
+    smartpromise
 }

tslint.json

@@ -1,3 +1,10 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false
+  },
+  "defaultSeverity": "warning"
 }