{"_id":"@analyz-product-analytics/analytics-sdk","_rev":"7-d0e6d30066cfba6fd8a8640e74bab374","name":"@analyz-product-analytics/analytics-sdk","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.0":{"name":"@analyz-product-analytics/analytics-sdk","version":"1.0.0","keywords":[],"author":"","license":"ISC","_id":"@analyz-product-analytics/analytics-sdk@1.0.0","maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"dist":{"shasum":"7e47f43e655e02c4f135289b87692f4b352a0541","tarball":"https://registry.npmjs.org/@analyz-product-analytics/analytics-sdk/-/analytics-sdk-1.0.0.tgz","fileCount":5,"integrity":"sha512-ckG2cEZdjMBBtVV9ffH5Gj7g0a+m/0yZxTOtOp0Au19Q4y2nGwqtfJO21rCJKjhFBih1MQOo7rmHbisI7/kVzA==","signatures":[{"sig":"MEYCIQDO3sUYKT4WHdKmrsScfxHDUPV2jwGPPM2iF09lDG9xEwIhAPC0HSdPXCPFC+ylxHbfbJRDDeM5XtufrFqUG6zdd1Cw","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":14827},"main":"index.js","type":"commonjs","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"kkbot","email":"kisnakk1503@gmail.com"},"_npmVersion":"11.6.0","description":"","directories":{},"_nodeVersion":"24.9.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/analytics-sdk_1.0.0_1765810958904_0.23266740258663354","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@analyz-product-analytics/analytics-sdk","version":"1.0.1","keywords":[],"author":"","license":"ISC","_id":"@analyz-product-analytics/analytics-sdk@1.0.1","maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"dist":{"shasum":"ef430d7ea8db7cf1674a49c71e45f217e66050d2","tarball":"https://registry.npmjs.org/@analyz-product-analytics/analytics-sdk/-/analytics-sdk-1.0.1.tgz","fileCount":6,"integrity":"sha512-jI3O3m/u2RWp9SqimKDslnK3fjtglnZDYHsutK48oxRBfy0V1ZYbWotOBD0EtdoPjjNt8A2MDI6d6KRX0w/j4g==","signatures":[{"sig":"MEUCIGva1fcS3ih8mY6IbYusTBqya94CndFVTQkuySuF+rKtAiEA1JtI2WISZtDhbjyTgzlb7vQ5b+Th24xusen5Ezz/U5A=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18740},"main":"index.js","type":"commonjs","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"kkbot","email":"kisnakk1503@gmail.com"},"_npmVersion":"11.6.0","description":"A lightweight, developer-friendly analytics SDK for tracking page views, user sessions, and custom events in your web applications.","directories":{},"_nodeVersion":"24.9.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/analytics-sdk_1.0.1_1765811176975_0.6375944683452224","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@analyz-product-analytics/analytics-sdk","version":"1.0.2","keywords":[],"author":"","license":"ISC","_id":"@analyz-product-analytics/analytics-sdk@1.0.2","maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"dist":{"shasum":"05d7100a774344aa0c8ed4689cf7fca370a50280","tarball":"https://registry.npmjs.org/@analyz-product-analytics/analytics-sdk/-/analytics-sdk-1.0.2.tgz","fileCount":6,"integrity":"sha512-PAOijfmyrJy/EiZ3Nws+c9tiXpZQDmqTjYwkIGlAUVoQE8F1TjnL14SRLa/7gGwCuoCOSyEdXsVN12ZqJ7QDGA==","signatures":[{"sig":"MEUCIQD/lS7EQZHehpsJ44GQ0BC4dyjKoj9v74Tgce2Y0OfU0AIgI2mbSZOxdmI0HPKJn73DMK3XHOLS4/n6oj+geYwpSzk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18796},"main":"index.js","type":"commonjs","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"kkbot","email":"kisnakk1503@gmail.com"},"_npmVersion":"11.6.0","description":"A lightweight, developer-friendly analytics SDK for tracking page views, user sessions, and custom events in your web applications.","directories":{},"_nodeVersion":"24.9.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/analytics-sdk_1.0.2_1765811354908_0.7076062736269702","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@analyz-product-analytics/analytics-sdk","version":"1.0.3","keywords":[],"author":"","license":"ISC","_id":"@analyz-product-analytics/analytics-sdk@1.0.3","maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"dist":{"shasum":"1faf93671cb88f69df7cffb8482ec73f47ed7ca8","tarball":"https://registry.npmjs.org/@analyz-product-analytics/analytics-sdk/-/analytics-sdk-1.0.3.tgz","fileCount":6,"integrity":"sha512-TLqgCCD4bCa0qhmrwP3FD215RYUuXWV/YpQyKegXIgdub2clOboA8rybfkJVuB5cAjbbutTaKAvrzdhKnVL7hA==","signatures":[{"sig":"MEYCIQCEysblQVK3CbiMU0ytF+NtWZg8pjUlo2tQK3+raLglhwIhAJKU5af5qLbbbeeD3fjManj7/XpbA7C9Lraz8bXqhgLw","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18707},"main":"index.js","type":"commonjs","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"kkbot","email":"kisnakk1503@gmail.com"},"_npmVersion":"11.6.0","description":"A lightweight, developer-friendly analytics SDK for tracking page views, user sessions, and custom events in your web applications.","directories":{},"_nodeVersion":"24.9.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/analytics-sdk_1.0.3_1765811578053_0.2946379179174625","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@analyz-product-analytics/analytics-sdk","version":"1.0.4","keywords":["analytics","sdk","tracking"],"author":"","license":"ISC","_id":"@analyz-product-analytics/analytics-sdk@1.0.4","maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"dist":{"shasum":"34d68dd6e0e38a935f2eaec16810211c953a6de7","tarball":"https://registry.npmjs.org/@analyz-product-analytics/analytics-sdk/-/analytics-sdk-1.0.4.tgz","fileCount":4,"integrity":"sha512-AXedFoscvF5IFYHugB+/OD2JU0+eiLn+vus91ydr/YW0OEhaMWvUKJQefUcS+6apgP75knpp/Lj6rfojkuSjFA==","signatures":[{"sig":"MEQCICTIkgKbTBayXeqvrJnaMv7mqGqdPJtPC0yAafdG61NeAiAr7HQo96cNhY2jBTWoxIryzKEs73JRcU4V2xV6X08DVQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":12836},"main":"dist/core.js","type":"commonjs","types":"dist/core.d.ts","gitHead":"3584f05a08091f2f15a5561e2f6e23a5ac4138ee","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"kkbot","email":"kisnakk1503@gmail.com"},"_npmVersion":"11.6.0","description":"A lightweight, developer-friendly analytics SDK","directories":{},"_nodeVersion":"24.9.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/analytics-sdk_1.0.4_1766208200373_0.12789672479490832","host":"s3://npm-registry-packages-npm-production"}},"1.0.5":{"name":"@analyz-product-analytics/analytics-sdk","version":"1.0.5","keywords":["analytics","sdk","tracking"],"author":"","license":"ISC","_id":"@analyz-product-analytics/analytics-sdk@1.0.5","maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"dist":{"shasum":"914d88cb70f3af547b9c4df21647c85e624d6936","tarball":"https://registry.npmjs.org/@analyz-product-analytics/analytics-sdk/-/analytics-sdk-1.0.5.tgz","fileCount":4,"integrity":"sha512-8zA6dih3jMqUpnPuHTySx55xHkf47VL4IH3BFkBD6y+9sbf54nVAdd/p/wtE8hJ5OT8tqTBR4HTYfNq7hcrbeA==","signatures":[{"sig":"MEUCIQDNr4sRU814GIz5aNSG+vOYXUBDipf/wx4vdpFRSkEWCwIgdQMSN6zqiD/DaiRlplU4BvUdVDc41QalRhMkHLUb+24=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":13367},"main":"dist/core.js","type":"commonjs","types":"dist/core.d.ts","gitHead":"b76008a3e89866e5717e1b706df5dc648cd4a1fb","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"kkbot","email":"kisnakk1503@gmail.com"},"_npmVersion":"11.6.0","description":"A lightweight, developer-friendly analytics SDK","directories":{},"_nodeVersion":"24.9.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/analytics-sdk_1.0.5_1766210135352_0.5891170692887291","host":"s3://npm-registry-packages-npm-production"}},"1.0.6":{"name":"@analyz-product-analytics/analytics-sdk","version":"1.0.6","description":"A lightweight, developer-friendly analytics SDK","main":"dist/core.js","types":"dist/core.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"keywords":["analytics","sdk","tracking"],"author":"","license":"ISC","type":"commonjs","devDependencies":{"typescript":"^5.9.3"},"_id":"@analyz-product-analytics/analytics-sdk@1.0.6","gitHead":"224d7a3aaa392ad132ea126f72f15dce65376578","_nodeVersion":"24.9.0","_npmVersion":"11.6.0","dist":{"integrity":"sha512-vbQ6HOqgidQ3qoHUwNOT9JjWU4EUVCEzjp3r6tfdSf+BeVImUI2ncKhiC5hg+dPk7VCdQErLmj+2synjlNdADQ==","shasum":"a94c8e67b642f3312d14fef0b370a14ecf530b95","tarball":"https://registry.npmjs.org/@analyz-product-analytics/analytics-sdk/-/analytics-sdk-1.0.6.tgz","fileCount":4,"unpackedSize":13363,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIDckh4POOMVKFAEYNKLki8uZKa2OAZl2BvYitTV2YwBfAiABmUh+5J0x8vWqATJoz+TF3nDU2NmfvAEcIQ3V75NcQA=="}]},"_npmUser":{"name":"kkbot","email":"kisnakk1503@gmail.com"},"directories":{},"maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/analytics-sdk_1.0.6_1766210348381_0.5265510541915797"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-15T15:02:38.812Z","modified":"2025-12-20T05:59:08.766Z","1.0.0":"2025-12-15T15:02:39.062Z","1.0.1":"2025-12-15T15:06:17.129Z","1.0.2":"2025-12-15T15:09:15.043Z","1.0.3":"2025-12-15T15:12:58.213Z","1.0.4":"2025-12-20T05:23:20.520Z","1.0.5":"2025-12-20T05:55:35.489Z","1.0.6":"2025-12-20T05:59:08.542Z"},"license":"ISC","keywords":["analytics","sdk","tracking"],"description":"A lightweight, developer-friendly analytics SDK","maintainers":[{"name":"kkbot","email":"kisnakk1503@gmail.com"}],"readme":"# Analyz Analytics SDK\r\n\r\nA lightweight, developer-friendly analytics SDK for tracking page views, user sessions, and custom events in your web applications.\r\n\r\n![npm version](https://img.shields.io/npm/v/@analyz-product-analytics/analytics-sdk)\r\n![license](https://img.shields.io/npm/l/@analyz-product-analytics/analytics-sdk)\r\n\r\n## Features\r\n\r\n* 🚀 **Lightweight:** Minimal footprint (< 5KB gzipped).\r\n* 🔄 **Automatic Session Management:** Handles session persistence across reloads.\r\n* 🕵️ **Anonymous Tracking:** auto-generates IDs for unidentified users.\r\n* ⚛️ **Framework Agnostic:** Works with Vanilla JS, React, Next.js, Vue, etc.\r\n* ⚡ **SPA Support:** Automatically tracks route changes in Single Page Applications.\r\n* 🛡️ **Type-Safe:** Built with TypeScript for full autocomplete support.\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @analyz-product-analytics/analytics-sdk\r\n# or\r\nyarn add @analyz-product-analytics/analytics-sdk\r\n# or\r\npnpm add @analyz-product-analytics/analytics-sdk\r\n```\r\n\r\n## Quick Start\r\n1. Initialize the SDK\r\nInitialize the SDK as early as possible in your application (e.g., in your root layout or entry file).\r\n\r\n```JavaScript\r\n\r\nimport { init } from '@analyz-product-analytics/analytics-sdk';\r\n\r\ninit('YOUR_PROJECT_API_KEY', {\r\n debug: false, // Set to true to see logs in console\r\n});\r\n``` \r\n2. Automatic Page View Tracking\r\nFor Single Page Applications (Next.js, React Router), start page tracking once. It will automatically listen to History API changes.\r\n\r\n\r\n```JavaScript\r\n\r\nimport { startPageTracking } from '@analyz-product-analytics/analytics-sdk';\r\n\r\n// Starts tracking initial page load + all future navigation\r\nstartPageTracking();\r\n```\r\n\r\n## Usage Guide\r\n### Identifying Users\r\nWhen a user logs in, identify them to link their anonymous session to their actual user ID.\r\n\r\n\r\n```JavaScript\r\n\r\nimport { identify } from '@analyz-product-analytics/analytics-sdk';\r\n\r\n// Call this after successful login\r\nidentify('user_12345');\r\n```\r\n\r\n### Tracking Custom Events\r\nTrack specific user interactions like button clicks, form submissions, or errors.\r\n \r\n\r\n```JavaScript\r\n\r\nimport { track } from '@analyz-product-analytics/analytics-sdk';\r\n\r\n// Track a simple event\r\ntrack('add_to_cart');\r\n\r\n// Track with properties\r\ntrack('purchase_completed', {\r\n item_id: 'prod_999',\r\n value: 49.99,\r\n currency: 'USD',\r\n plan: 'premium'\r\n});\r\n```\r\n\r\n## Integration Examples\r\n### Next.js (App Router)\r\nCreate a client component to handle initialization (e.g., components/AnalyticsProvider.tsx).\r\n\r\n\r\n```TypeScript\r\n\r\n'use client';\r\n\r\nimport { useEffect } from 'react';\r\nimport { init, startPageTracking } from '@analyz-product-analytics/analytics-sdk';\r\n\r\nexport function AnalyticsProvider() {\r\n useEffect(() => {\r\n // 1. Initialize\r\n init('YOUR_API_KEY');\r\n \r\n // 2. Start automatic page tracking\r\n startPageTracking();\r\n }, []);\r\n\r\n return null;\r\n}\r\n```\r\nThen add it to your app/layout.tsx:\r\n\r\n```TypeScript\r\n\r\nimport { AnalyticsProvider } from './components/AnalyticsProvider';\r\n\r\nexport default function RootLayout({ children }) {\r\n return (\r\n \r\n \r\n \r\n {children}\r\n \r\n \r\n );\r\n}\r\n```\r\n\r\n## API Reference\r\n#### **init(apiKey, options?)**\r\nInitializes the SDK instance.\r\n\r\n* **apiKey**\t string\t Required. Your project's unique identifier.\r\n* **options**\t object\t Optional configuration settings.\r\n\r\n### Options Object:\r\n* **debug** (boolean): If true, logs all events and errors to the browser console. Default: false.\r\n* **endpoint** (string): Overrides the default API URL. Useful for local testing or proxying events.\r\n\r\n#### **identify(userId)**\r\nLinks the current session to a specific user ID.\r\n\r\n* **userId** string\t Required. The unique ID of the user from your database.\r\n\r\n\r\n#### **track(eventName, properties?)**\r\nSends a custom event to the analytics server.\r\n\r\n* **eventName** string Required. The name of the event (e.g., \"signup_clicked\").\r\n* **properties** object Optional key-value pairs of metadata (e.g., { price: 100 }).\r\n\r\n\r\n#### **startPageTracking(options?)**\r\nEnables automatic tracking of page views on route changes.\r\n### Options Object:\r\n* **trackReferrer** (boolean): Capture where the user came from. Default: **true**.\r\n* **trackTitle** (boolean): Capture the document title. Default: **true**.\r\n","readmeFilename":"README.md"}