Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
7d377e31c2 | |||
fcb12d5734 | |||
febf6c1911 | |||
457ac52a14 |
27
README.md
27
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
|
||||
and where to spend resources for best efficiency.
|
||||
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 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'
|
||||
let myAnalyticsAccount = new AnalyticsAccount('My App Name', 'UA-XXXXXX-Y')
|
||||
myAnalyticsAccount.sendEvent('npmtool', 'install', 'somelabel')
|
||||
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)
|
||||
|
@ -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
|
||||
and where to spend resources for best efficiency.
|
||||
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 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'
|
||||
let myAnalyticsAccount = new AnalyticsAccount('My App Name', 'UA-XXXXXX-Y')
|
||||
myAnalyticsAccount.sendEvent('npmtool', 'install', 'somelabel')
|
||||
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)
|
||||
|
19
license
Normal file
19
license
Normal file
@ -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.
|
@ -2,8 +2,7 @@
|
||||
"npmts": {
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [
|
||||
"npmts"
|
||||
]
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
}
|
||||
}
|
1046
package-lock.json
generated
Normal file
1046
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
20
package.json
20
package.json
@ -1,20 +1,24 @@
|
||||
{
|
||||
"name": "smartanalytics",
|
||||
"version": "2.0.9",
|
||||
"name": "@pushrocks/smartanalytics",
|
||||
"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",
|
||||
"smartrequest": "^1.0.4",
|
||||
"typings-global": "^1.0.14"
|
||||
"@pushrocks/smartpromise": "^2.0.5",
|
||||
"@pushrocks/smartrequest": "^1.1.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"
|
||||
}
|
||||
}
|
||||
|
24
test/test.ts
24
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({
|
||||
projectId: 'sandbox',
|
||||
appName: 'smartanalytics',
|
||||
apiEndPoint: '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();
|
||||
|
@ -1 +1 @@
|
||||
export { Analytics } from './smartanalytics.classes.analytics'
|
||||
export { Analytics } from './smartanalytics.classes.analytics';
|
||||
|
@ -1,39 +1,41 @@
|
||||
import * as plugins from './smartanalytics.plugins'
|
||||
import * as plugins from './smartanalytics.plugins';
|
||||
|
||||
export class Analytics {
|
||||
projectId: string
|
||||
appName: string
|
||||
apiEndPoint: string
|
||||
secretKey: string = ''
|
||||
constructor (optionsArg: {
|
||||
projectId: string
|
||||
appName: string
|
||||
apiEndPoint: string
|
||||
secretKey?: string
|
||||
public projectId: string;
|
||||
public appName: string;
|
||||
public apiEndPoint: string;
|
||||
public secretKey: string = '';
|
||||
constructor(optionsArg: {
|
||||
projectId: string;
|
||||
appName: string;
|
||||
apiEndPoint: string;
|
||||
secretKey?: string;
|
||||
}) {
|
||||
this.projectId = optionsArg.projectId
|
||||
this.appName = optionsArg.appName
|
||||
this.apiEndPoint = optionsArg.apiEndPoint
|
||||
this.projectId = optionsArg.projectId;
|
||||
this.appName = optionsArg.appName;
|
||||
this.apiEndPoint = optionsArg.apiEndPoint;
|
||||
if (optionsArg.secretKey) {
|
||||
this.secretKey = optionsArg.secretKey
|
||||
this.secretKey = optionsArg.secretKey;
|
||||
}
|
||||
}
|
||||
|
||||
async recordEvent (eventIdArg: string, analyticsDataArg: any) {
|
||||
async recordEvent(eventIdArg: string, analyticsDataArg: any) {
|
||||
let dataToSend = {
|
||||
projectId: this.projectId,
|
||||
appName: this.appName,
|
||||
eventId: eventIdArg,
|
||||
analyticsData: analyticsDataArg
|
||||
}
|
||||
await plugins.smartrequest.post(this.apiEndPoint, {
|
||||
headers: {
|
||||
'authenticate': this.secretKey,
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
requestBody: dataToSend
|
||||
}).catch(err => {
|
||||
console.log(err)
|
||||
})
|
||||
};
|
||||
await plugins.smartrequest
|
||||
.postJson(this.apiEndPoint, {
|
||||
headers: {
|
||||
authenticate: this.secretKey,
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
requestBody: dataToSend
|
||||
})
|
||||
.catch(err => {
|
||||
console.log(err);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
@ -1,8 +1,7 @@
|
||||
import 'typings-global'
|
||||
import * as smartrequest from 'smartrequest'
|
||||
import * as smartq from 'smartq'
|
||||
import * as smartrequest from '@pushrocks/smartrequest';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
|
||||
export {
|
||||
smartrequest,
|
||||
smartq
|
||||
smartpromise
|
||||
}
|
||||
|
@ -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"
|
||||
}
|
||||
|
Reference in New Issue
Block a user