UNPKG

@snowplow/javascript-tracker

Version:
120 lines 7.34 kB
{ "name": "@snowplow/javascript-tracker", "version": "3.15.0", "description": "Web analytics for Snowplow", "keywords": [ "tracking", "web analytics", "events", "open source" ], "homepage": "http://bit.ly/sp-js", "bugs": "https://github.com/snowplow/snowplow-javascript-tracker/issues", "repository": { "type": "git", "url": "https://github.com/snowplow/snowplow-javascript-tracker.git" }, "license": "BSD-3-Clause", "contributors": [ "Alex Dean", "Simon Andersson", "Anthon Pang", "Fred Blundun", "Joshua Beemster", "Michael Hadam", "Paul Boocock" ], "browser": "dist/sp.js", "files": [ "dist" ], "dependencies": { "@snowplow/browser-plugin-ad-tracking": "3.15.0", "@snowplow/browser-plugin-browser-features": "3.15.0", "@snowplow/browser-plugin-client-hints": "3.15.0", "@snowplow/browser-plugin-consent": "3.15.0", "@snowplow/browser-plugin-ecommerce": "3.15.0", "@snowplow/browser-plugin-enhanced-ecommerce": "3.15.0", "@snowplow/browser-plugin-error-tracking": "3.15.0", "@snowplow/browser-plugin-form-tracking": "3.15.0", "@snowplow/browser-plugin-ga-cookies": "3.15.0", "@snowplow/browser-plugin-geolocation": "3.15.0", "@snowplow/browser-plugin-link-click-tracking": "3.15.0", "@snowplow/browser-plugin-media-tracking": "3.15.0", "@snowplow/browser-plugin-optimizely": "3.15.0", "@snowplow/browser-plugin-optimizely-x": "3.15.0", "@snowplow/browser-plugin-performance-timing": "3.15.0", "@snowplow/browser-plugin-site-tracking": "3.15.0", "@snowplow/browser-plugin-snowplow-ecommerce": "3.15.0", "@snowplow/browser-plugin-timezone": "3.15.0", "@snowplow/browser-plugin-youtube-tracking": "3.15.0", "@snowplow/browser-plugin-media": "3.15.0", "@snowplow/browser-plugin-vimeo-tracking": "3.15.0", "@snowplow/browser-tracker": "3.15.0", "@snowplow/browser-tracker-core": "3.15.0", "@snowplow/tracker-core": "3.15.0", "tslib": "^2.3.1", "@snowplow/browser-plugin-enhanced-consent": "3.15.0", "@snowplow/browser-plugin-privacy-sandbox": "3.15.0" }, "devDependencies": { "@ampproject/rollup-plugin-closure-compiler": "~0.27.0", "@rollup/plugin-alias": "~3.1.9", "@rollup/plugin-commonjs": "~21.0.2", "@rollup/plugin-json": "~4.1.0", "@rollup/plugin-node-resolve": "~13.1.3", "@rollup/plugin-replace": "~4.0.0", "@types/dockerode": "~3.3.5", "@types/jest": "~27.4.1", "@types/jsdom": "~16.2.14", "@types/lodash": "~4.14.180", "@types/node": "~14.6.0", "@wdio/cli": "~8.3.3", "@wdio/jasmine-framework": "~8.3.3", "@wdio/local-runner": "~8.3.3", "@wdio/sauce-service": "~8.3.3", "@wdio/spec-reporter": "~8.3.0", "@wdio/static-server-service": "~8.3.0", "@wdio/types": "~8.3.0", "chalk": "4.1.2", "chromedriver": "~114.0.0", "dockerode": "~3.3.1", "jest": "~27.5.1", "jest-environment-jsdom": "~27.5.1", "jest-environment-jsdom-global": "~3.0.0", "jest-standard-reporter": "~2.0.0", "lodash": "~4.17.21", "npm-run-all": "~4.1.5", "rollup": "~2.70.1", "rollup-plugin-cleanup": "~3.2.1", "rollup-plugin-filesize": "~9.1.2", "rollup-plugin-license": "~2.6.1", "rollup-plugin-sizes": "~1.0.4", "rollup-plugin-terser": "~7.0.2", "rollup-plugin-ts": "~2.0.5", "saucelabs": "~7.2.0", "ts-jest": "~27.1.3", "ts-node": "~10.9.1", "typescript": "~4.6.2", "wdio-chromedriver-service": "~8.0.1", "webdriverio": "~8.3.3", "@wdio/shared-store-service": "~8.11.2", "node-fetch": "2", "@types/node-fetch": "2", "@wdio/globals": "~8.11.2", "wdio-safaridriver-service": "~2.1.0", "wdio-edgedriver-service": "~3.0.2", "@types/youtube": "~0.0.46" }, "scripts": { "build": "rollup -c --silent --failAfterWarnings", "docker:micro": "docker pull snowplow/snowplow-micro:latest", "test": "jest test/unit/*.test.ts --no-cache", "test:build": "rollup --config rollup.config.test.js --silent", "test:e2e:local": "npm-run-all --parallel test:build docker:micro --serial wdio:local", "test:e2e:sauce": "npm-run-all --parallel test:build docker:micro --serial wdio:sauce", "wdio:local": "wdio run ./test/wdio.local.conf.ts", "wdio:sauce": "wdio run ./test/wdio.sauce.conf.ts" }, "readme": "# Snowplow JavaScript Tracker\n\n[![npm version][npm-image]][npm-url]\n[![License][license-image]](LICENSE)\n\nAdd Snowplow Tracking to your website via a tag solution.\n\n## Maintainer quick start\n\nPart of the Snowplow JavaScript Tracker monorepo. \nBuild with [Node.js](https://nodejs.org/en/) (14 or 16) and [Rush](https://rushjs.io/).\n\n### Setup repository\n\n```bash\nnpm install -g @microsoft/rush \ngit clone https://github.com/snowplow/snowplow-javascript-tracker.git\nrush update\n```\n\n## Select your version\n\nThis repository creates two versions of the tracker. \n\nThe fully featured `sp.js` contains the majority of the plugins included within this repository for a complete tracking experience. This is our recommended version.\n\nHowever, if you'd like a lightweight version of the tracker you can opt for `sp.lite.js`. \nThis version only includes Page Views, Page Activity, Structured and Self Describing events as well as global contexts and anonymous tracking.\n\n## Installation\n\nAdd the tag to your website or Tag Management solution:\n\n```html\n<script type=\"text/javascript\" async=1>\n;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[]; p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments) };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1; n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,\"script\",\"{{URL to sp.js}}\",\"snowplow\"));\n</script>\n\n<script>\nwindow.snowplow('newTracker', 'sp', collector_endpoint, {\n appId: 'my-app',\n eventMethod: 'post',\n contexts: {\n performanceTiming: true,\n },\n});\n</script>\n```\n\nWe advise you host `sp.js` or `sp.lite.js` yourself, and rename it. However if you'd like use a CDN, you'll find the tracker on jsDelivr, unpkg and cdnjs.\n\n## Usage\n\n```js\nwindow.snowplow('enableLinkClickTracking');\n\nwindow.snowplow('trackPageView', {\n title: 'My Title',\n context: [\n // Set page title; add page context\n {\n schema: 'iglu:org.schema/WebPage/jsonschema/1-0-0',\n data: {\n keywords: ['tester'],\n },\n },\n ],\n});\n\nwindow.snowplow('trackSelfDescribingEvent', {\n event: {\n schema: 'iglu:com.acme/my_event/jsonschema/1-0-0',\n data: {\n myId: '12345-abc',\n },\n }\n});\n```\n\n## Copyright and license\n\nLicensed and distributed under the [BSD 3-Clause License](LICENSE) ([An OSI Approved License][osi]).\n\nCopyright (c) 2022 Snowplow Analytics Ltd, 2010 Anthon Pang.\n\nAll rights reserved.\n\n[npm-url]: https://www.npmjs.com/package/@snowplow/browser-tracker\n[npm-image]: https://img.shields.io/npm/v/@snowplow/browser-tracker\n[docs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/javascript-tracker/\n[osi]: https://opensource.org/licenses/BSD-3-Clause\n[license-image]: https://img.shields.io/npm/l/@snowplow/javascript-tracker\n" }