{"_id":"@airtame/analytics-plugin-data-broker","name":"@airtame/analytics-plugin-data-broker","dist-tags":{"latest":"1.1.0"},"versions":{"1.1.0":{"name":"@airtame/analytics-plugin-data-broker","description":"Plugin for the analytics package which sends analytics events to data-broker","version":"1.1.0","type":"module","main":"./dist/airtame-data-broker.js","scripts":{"dev":"vite","build":"tsc && vite build","prettier":"prettier --check 'src' '*.md'","eslint":"eslint --max-warnings 0 'src'"},"devDependencies":{"@typescript-eslint/eslint-plugin":"6.9.0","analytics":"0.8.9","eslint":"8.52.0","eslint-config-prettier":"9.0.0","eslint-import-resolver-typescript":"3.6.1","eslint-plugin-import":"2.29.0","eslint-plugin-unicorn":"48.0.1","prettier":"3.0.3","typescript":"5.2.2","vite":"4.5.0","vite-plugin-dts":"3.6.3"},"dependencies":{"@types/ua-parser-js":"0.7.39","ua-parser-js":"1.0.37"},"_id":"@airtame/analytics-plugin-data-broker@1.1.0","gitHead":"06bea9a9bc5fdf9840b8270beb0ffb4e799cc979","types":"./dist/airtame-data-broker.d.ts","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-rAJAqwBkDc6FRryoS1g0vgi3iM5jnSWlZgSPrMtO1zYk6W/+jeLOqY4DNPOfKhnjg1oK8zJtjMckcbB0tI5/ug==","shasum":"13c9a055ddd4161614889cc1846fc0b02d70c7ac","tarball":"https://registry.npmjs.org/@airtame/analytics-plugin-data-broker/-/analytics-plugin-data-broker-1.1.0.tgz","fileCount":4,"unpackedSize":41435,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDJf4xvU020Uq2FBb/70m2ui8Ik4yXkBJu5H2ZUYtg0qgIgOiyO8rVDkmO75rUEL3VZfj2BmNev8OfUoJCfl6l+hns="}]},"_npmUser":{"name":"airtame-ops","email":"devops@airtame.com"},"directories":{},"maintainers":[{"name":"rene-airtame","email":"rene.hansen@airtame.com"},{"name":"airtame-ops","email":"devops@airtame.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analytics-plugin-data-broker_1.1.0_1711357315040_0.33585251913002967"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-25T09:01:54.936Z","1.1.0":"2024-03-25T09:01:55.257Z","modified":"2024-03-25T09:01:55.786Z"},"maintainers":[{"name":"rene-airtame","email":"rene.hansen@airtame.com"},{"name":"airtame-ops","email":"devops@airtame.com"}],"description":"Plugin for the analytics package which sends analytics events to data-broker","readme":"# analytics-plugin-data-broker\n\nIntegration with [Data Broker] for\n[analytics](https://www.npmjs.com/package/analytics).\n\nThis analytics plugin will enable sending of custom events, page views etc. to\n[Data Broker].\n\nCurrently only `track()` and `page()` methods are implmented, because that's all\nwe really need for DataBroker at this point.\n\n## Installation\n\nInstall `analytics` and `@airtame/analytics-plugin-data-broker` packages\n\n```bash\nnpm install analytics\nnpm install @airtame/analytics-plugin-data-broker\n```\n\n## How to use\n\nTo use, install the package, include in your project and initialize the plugin\nwith [analytics](https://www.npmjs.com/package/analytics).\n\nBelow is an example of how to use the browser plugin.\n\n```js\nimport Analytics from 'analytics';\nimport dataBrokerPlugin from '@airtame/analytics-plugin-data-broker';\n\nconst analytics = Analytics({\n  app: 'awesome-app',\n  plugins: [\n    dataBrokerPlugin({\n      url: 'https://data.dev.airtame.io/api/v1/tracks',\n      applicationId: 'D3D2C6A26F917F7ABCDEFG1234567',\n      applicationVersion: 'v1.2.3',\n    }),\n  ],\n});\n\n/* Track a page view */\nanalytics.page();\n\n/* Track a custom event */\nanalytics.track('cartCheckout', {\n  item: 'pink socks',\n  price: 20,\n});\n```\n\nAfter initializing `analytics` with the `dataBrokerPlugin` plugin, data will be\nsent into DataBroker whenever\n[analytics.page](https://getanalytics.io/api/#analyticspage), or\n[analytics.track](https://getanalytics.io/api/#analyticstrack) are called.\n\n## Browser usage\n\nThe DataBroker client side browser plugin works with these analytic api methods:\n\n- **[analytics.page](https://getanalytics.io/api/#analyticspage)** - Sends page\n  views into DataBroker\n- **[analytics.track](https://getanalytics.io/api/#analyticstrack)** - Track\n  custom events and send to DataBroker\n\n### Configuration options\n\n| Option                                          | description                                                                                                    |\n| :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |\n| `url` <br/>**required** - string                | Url of DataBroker instance. This is configurable, to be able to distinquish e.g. `dev` and `prd` environments. |\n| `applicationId` <br/>**required** - string      | The unique id of the application.                                                                              |\n| `applicationVersion` <br/>**optional** - string | Semantic version of the application                                                                            |\n\n## Build\n\nTo build the library:\n\n```bash\n# Install the dependencies\nnpm install\n\n# Run the build script\nnpm run build\n```\n\nAfter that you have the artifacts in the `dist/` folder.\n\n## [CHANGELOG](./CHANGELOG.md)\n\n[data broker]: https://gitlab.internal.airtame.com/airtame/bi/data-broker\n","readmeFilename":"README.md"}