{"_id":"@amplitude/plugin-page-view-v1-enrichment-browser","_rev":"19-9e6f0a8fec7dcb6b08e14159f1c1b1a5","name":"@amplitude/plugin-page-view-v1-enrichment-browser","dist-tags":{"latest":"1.0.0"},"versions":{"0.1.0":{"name":"@amplitude/plugin-page-view-v1-enrichment-browser","version":"0.1.0","author":{"name":"Amplitude Inc"},"license":"MIT","_id":"@amplitude/plugin-page-view-v1-enrichment-browser@0.1.0","maintainers":[{"name":"alec.amplitude","email":"alec.boutin@amplitude.com"},{"name":"amplicynthia","email":"cynthia.li@amplitude.com"},{"name":"mae.capozzi","email":"mae.capozzi@amplitude.com"},{"name":"sdk.dev","email":"sdk.dev@amplitude.com"},{"name":"dnshi","email":"dean.xiaoshi@gmail.com"},{"name":"kevinpagtakhan","email":"kevpagtakhan@gmail.com"},{"name":"justin-fiedler","email":"jbfiedler@gmail.com"},{"name":"qingzhuo","email":"qingzhuo.zhen@amplitude.com"},{"name":"rctbusk","email":"rctbusk@gmail.com"},{"name":"jackmccloy","email":"dryice82@gmail.com"},{"name":"amp_haoliu","email":"hao.liu@amplitude.com"},{"name":"myztiq","email":"npm@ryan-kahn.com"},{"name":"curtisbliu","email":"curtis@amplitude.com"},{"name":"jtran","email":"jptran318@gmail.com"},{"name":"kelvin-lu","email":"kelvin@amplitude.com"},{"name":"nutwani","email":"nirmal@amplitude.com"},{"name":"hao.yu","email":"hao.yu@amplitude.com"},{"name":"kelson.warner","email":"kelson.warner@amplitude.com"},{"name":"ajhorst_amp","email":"aj.horst@amplitude.com"},{"name":"brian.giori","email":"brian.giori@amplitude.com"}],"homepage":"https://github.com/amplitude/Amplitude-TypeScript","bugs":{"url":"https://github.com/amplitude/Amplitude-TypeScript/issues"},"dist":{"shasum":"33814abf3451a69b04c19226c53ff835c6c83f92","tarball":"https://registry.npmjs.org/@amplitude/plugin-page-view-v1-enrichment-browser/-/plugin-page-view-v1-enrichment-browser-0.1.0.tgz","fileCount":37,"integrity":"sha512-Dj6B3zDNaOq3WkQJO+mgM0j8caTHgIXyWVzIBcPR5kap7t5+ejACwhEYWM1ZCfudi0LH4CE/68uIFjnA403kNg==","signatures":[{"sig":"MEUCIQDdDEySwpF/Qha9YfvZuBbt61PdF8l5BsED1X6k8rSDAwIgKiOwsZpSoTRPn/QMyGNdBYYzNoQncd6zW9gevL2ZKFE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":31643},"main":"lib/cjs/index.js","types":"lib/esm/index.d.ts","module":"lib/esm/index.js","gitHead":"f9bb21699dd3d44dbca3318141249c3a57ce1000","scripts":{"fix":"yarn fix:eslint & yarn fix:prettier","lint":"yarn lint:eslint & yarn lint:prettier","test":"jest","build":"yarn bundle && yarn build:es5 && yarn build:esm","clean":"rimraf node_modules lib coverage","bundle":"rollup --config rollup.config.js","build:es5":"tsc -p ./tsconfig.es5.json","build:esm":"tsc -p ./tsconfig.esm.json","typecheck":"tsc -p ./tsconfig.json","fix:eslint":"eslint '{src,test}/**/*.ts' --fix","lint:eslint":"eslint '{src,test}/**/*.ts'","fix:prettier":"prettier --write \"{src,test}/**/*.ts\"","lint:prettier":"prettier --check \"{src,test}/**/*.ts\""},"_npmUser":{"name":"sdk.dev","email":"sdk.dev@amplitude.com"},"repository":{"url":"git+https://github.com/amplitude/Amplitude-TypeScript.git","type":"git"},"_npmVersion":"lerna/6.1.0/node@v16.20.1+x64 (linux)","description":"

\n \n \n \n
\n

\n\n# @amplitude/@amplitude/plugin-page-view-v1-enrichment-browser\n\nOfficial Browser SDK plugin for making page view event compatible with browser v1.\n\n## Installation\n\nThis package is published on NPM registry and is available to be installed using npm and yarn.\n\n```sh\n# npm\nnpm install @amplitude/plugin-page-view-v1-enrichment-browser@^1.0.0\n\n# yarn\nyarn add @amplitude/plugin-page-view-v1-enrichment-browser@^1.0.0\n```\n\n## Usage\n\nThis plugin works on top of the Amplitude Browser SDK. It's used for updating the page view event_type and event_properties the same as Browser v1.\nIn Browser v2.x, we have enriched the page view event_type and event_propertis. You can use this plugin to maintain consistency with page view tracking from earlier SDK versions.\n\n### 1. Import Amplitude packages\n\n* `@amplitude/analytics-browser`\n* `@amplitude/plugin-page-view-v1-enrichment-browser`\n\n```typescript\nimport * as amplitude from '@amplitude/analytics-browser';\nimport { pageViewV1EnrichmentPlugin } from '@amplitude/plugin-page-view-v1-enrichment-browser';\n```\n\n### 2. Instantiate page view v1 enrichment plugin\n\n```typescript\nconst pageViewPlugin = pageViewV1EnrichmentPlugin();\n```\n\n### 3. Install plugin to Amplitude SDK\n\n```typescript\namplitude.add(pageViewPlugin);\n```\n\n### 4. Initialize Amplitude SDK\n\n```typescript\namplitude.init('API_KEY');\n```\n\n## Resulting on page view event\n\n| property |[Browser SDK 2.0](../) | With this plugin |\n| --- | --- | --- |\n| `Event Type` | `[Amplitude] Page Viewed` | `Page View` |\n| `Event Properties` | `page_domain` | `[Amplitude] Page Domain` |\n| | `page_location` | `[Amplitude] Page Location` |\n| | `page_path` | `[Amplitude] Page Path` |\n| | `page_title` | `[Amplitude] Page Title` |\n| | `page_url` | `[Amplitude] Page URL`|\n","readmeFilename":"README.md"}