Compare commits
13 Commits
Author | SHA1 | Date | |
---|---|---|---|
495a3ffafd | |||
ffd1274f21 | |||
8e4ad6159a | |||
c5a2383fd3 | |||
2c25cd0655 | |||
370caae226 | |||
75c3979120 | |||
b5d792d58c | |||
05b80b618b | |||
511b7ee143 | |||
08d37dc037 | |||
2b5056085c | |||
8f31088ab5 |
@ -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:
|
||||
|
10
dist/smartanalytics.classes.analytics.d.ts
vendored
10
dist/smartanalytics.classes.analytics.d.ts
vendored
@ -4,10 +4,10 @@ export declare class Analytics {
|
||||
apiEndPoint: string;
|
||||
secretKey: string;
|
||||
constructor(optionsArg: {
|
||||
projectIdArg: string;
|
||||
appNameArg: string;
|
||||
apiEndPointArg: string;
|
||||
secretKeyArg?: string;
|
||||
projectId: string;
|
||||
appName: string;
|
||||
apiEndPoint: string;
|
||||
secretKey?: string;
|
||||
});
|
||||
recordEvent(identifierArg: string, analyticsDataArg: any): Promise<void>;
|
||||
recordEvent(eventIdArg: string, analyticsDataArg: any): Promise<void>;
|
||||
}
|
||||
|
16
dist/smartanalytics.classes.analytics.js
vendored
16
dist/smartanalytics.classes.analytics.js
vendored
@ -12,19 +12,19 @@ const plugins = require("./smartanalytics.plugins");
|
||||
class Analytics {
|
||||
constructor(optionsArg) {
|
||||
this.secretKey = '';
|
||||
this.projectId = optionsArg.projectIdArg;
|
||||
this.appName = optionsArg.appNameArg;
|
||||
this.apiEndPoint = optionsArg.apiEndPointArg;
|
||||
if (optionsArg.secretKeyArg) {
|
||||
this.secretKey = optionsArg.secretKeyArg;
|
||||
this.projectId = optionsArg.projectId;
|
||||
this.appName = optionsArg.appName;
|
||||
this.apiEndPoint = optionsArg.apiEndPoint;
|
||||
if (optionsArg.secretKey) {
|
||||
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
|
46
docs/index.md
Normal file
46
docs/index.md
Normal file
@ -0,0 +1,46 @@
|
||||
# smartanalytics
|
||||
Google Analytics everywhere
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/smartanalytics)
|
||||
[](https://GitLab.com/pushrocks/smartanalytics)
|
||||
[](https://github.com/pushrocks/smartanalytics)
|
||||
[](https://pushrocks.gitlab.io/smartanalytics/)
|
||||
|
||||
## Status for master
|
||||
[](https://GitLab.com/pushrocks/smartanalytics/commits/master)
|
||||
[](https://GitLab.com/pushrocks/smartanalytics/commits/master)
|
||||
[](https://www.npmjs.com/package/smartanalytics)
|
||||
[](https://david-dm.org/pushrocks/smartanalytics)
|
||||
[](https://www.bithound.io/github/pushrocks/smartanalytics/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/smartanalytics)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## Usage
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
### 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')
|
||||
```
|
||||
|
||||
For further information read the linked docs at the top of this README.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
|
||||
[](https://push.rocks)
|
@ -1,9 +1,8 @@
|
||||
{
|
||||
"npmts": {
|
||||
"coverageTreshold": 40
|
||||
},
|
||||
"npmci": {
|
||||
"globalNpmTools": [
|
||||
"npmGlobalTools": [
|
||||
"npmts"
|
||||
]
|
||||
}
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "smartanalytics",
|
||||
"version": "2.0.3",
|
||||
"version": "2.0.9",
|
||||
"description": "Google Analytics everywhere",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
|
10
test/test.ts
10
test/test.ts
@ -6,16 +6,16 @@ let testAnalytics: smartanalytics.Analytics
|
||||
|
||||
tap.test('should create a valid AnalyticsAccount', async () => {
|
||||
testAnalytics = new smartanalytics.Analytics({
|
||||
projectIdArg: 'pushrocks',
|
||||
appNameArg: 'smartanalytics',
|
||||
apiEndPointArg: 'https://pubapi-1.lossless.one/analytics'
|
||||
projectId: 'sandbox',
|
||||
appName: 'smartanalytics',
|
||||
apiEndPoint: 'https://pubapi-1.lossless.one/analytics'
|
||||
})
|
||||
})
|
||||
|
||||
tap.test('should send a request to Google Analytics', async () => {
|
||||
tap.test('should send a request to Lossless API endpoint', async () => {
|
||||
let doit = async () => {
|
||||
await testAnalytics.recordEvent('sandbox', {
|
||||
someValue: 'someData'
|
||||
trackingPurpose: 'test'
|
||||
})
|
||||
await testAnalytics.recordEvent('sandbox', {
|
||||
someValue: 'someData'
|
||||
|
@ -6,24 +6,24 @@ export class Analytics {
|
||||
apiEndPoint: string
|
||||
secretKey: string = ''
|
||||
constructor (optionsArg: {
|
||||
projectIdArg: string
|
||||
appNameArg: string
|
||||
apiEndPointArg: string
|
||||
secretKeyArg?: string
|
||||
projectId: string
|
||||
appName: string
|
||||
apiEndPoint: string
|
||||
secretKey?: string
|
||||
}) {
|
||||
this.projectId = optionsArg.projectIdArg
|
||||
this.appName = optionsArg.appNameArg
|
||||
this.apiEndPoint = optionsArg.apiEndPointArg
|
||||
if (optionsArg.secretKeyArg) {
|
||||
this.secretKey = optionsArg.secretKeyArg
|
||||
this.projectId = optionsArg.projectId
|
||||
this.appName = optionsArg.appName
|
||||
this.apiEndPoint = optionsArg.apiEndPoint
|
||||
if (optionsArg.secretKey) {
|
||||
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, {
|
||||
|
Reference in New Issue
Block a user