{"_id":"@deeptaai/klaritics-web-sdk","_rev":"4-5dfafe40e2de3442bb5b287770879a9f","name":"@deeptaai/klaritics-web-sdk","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@deeptaai/klaritics-web-sdk","version":"1.0.0","keywords":["klaritics","analytics","web-analytics","session-replay","deeptaai","sdk"],"author":{"name":"Mahesh Pikki","email":"mahesh.p@deeptaai.com"},"license":"MIT","_id":"@deeptaai/klaritics-web-sdk@1.0.0","maintainers":[{"name":"mahesh.pikki","email":"mahesh.p@deeptaai.com"}],"dist":{"shasum":"7383939a93b5694ae7a1cbb9f2a82f529bc2d428","tarball":"https://registry.npmjs.org/@deeptaai/klaritics-web-sdk/-/klaritics-web-sdk-1.0.0.tgz","fileCount":11,"integrity":"sha512-P5zKQJO6q7RsFfx+5Zjf+zC0uANcMmdUB9HPObklpTm/yoAwcFFDmwz0B2R2EnGTMNnuquAIUQ/nfF2BqwsmBQ==","signatures":[{"sig":"MEUCIBGux+g2nccnquwY/Np2bvao2vcHqN108SWcgztmWtOeAiEA2qbCKBj9bfQURiP6dnh++4sJIE/ZApi0bni5RG96lo0=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":2650002},"main":"./dist/klaritics.min.js","_from":"file:deeptaai-klaritics-web-sdk-1.0.0.tgz","types":"./dist/klaritics.d.ts","unpkg":"./dist/klaritics.global.js","module":"./dist/klaritics.mjs","browser":"./dist/klaritics.global.js","exports":{".":{"types":"./dist/klaritics.d.ts","import":"./dist/klaritics.mjs","default":"./dist/klaritics.mjs","require":"./dist/klaritics.min.js"},"./package.json":"./package.json"},"scripts":{"dev":"pnpm exec tsup --watch","lint":"eslint './src/**/*.ts'","test":"vitest run","build":"pnpm exec tsup"},"_npmUser":{"name":"mahesh.pikki","email":"mahesh.p@deeptaai.com"},"jsdelivr":"./dist/klaritics.global.js","_resolved":"/tmp/bcbf8c66b581f6391922d0f44483bee2/deeptaai-klaritics-web-sdk-1.0.0.tgz","_integrity":"sha512-P5zKQJO6q7RsFfx+5Zjf+zC0uANcMmdUB9HPObklpTm/yoAwcFFDmwz0B2R2EnGTMNnuquAIUQ/nfF2BqwsmBQ==","repository":{"url":"git+https://citadel.deeptaai.com/klaritics/development/sdk/web/anthraweb.git","type":"git","directory":"packages/sdk-core"},"_npmVersion":"11.19.0","description":"Klaritics Web Analytics SDK","directories":{},"sideEffects":true,"_nodeVersion":"24.20.0","dependencies":{"pako":"^2.1.0","rrweb":"^2.0.0","@rrweb/rrweb-plugin-console-record":"^2.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.1","vitest":"^3.0.0","@types/pako":"^2.0.4"},"_npmOperationalInternal":{"tmp":"tmp/klaritics-web-sdk_1.0.0_1788262852647_0.8104582783364704","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"_id":"@deeptaai/klaritics-web-sdk@1.0.1","dist":{"shasum":"9d7a747a4048657141408062b31f048a1c611c38","tarball":"https://registry.npmjs.org/@deeptaai/klaritics-web-sdk/-/klaritics-web-sdk-1.0.1.tgz","fileCount":11,"integrity":"sha512-Wea0WC9Vvv5LoXp61DT9T/FXOny8HT3f6+0D2GVHWtbR7WYl5F7oOTMC2yOYbCfiT3Ffs0HPNV3lioMMB9gEZA==","signatures":[{"sig":"MEUCICxhIssUpHbQuNYUnob8Do/uPIiFk9/HLroahPNNtSj8AiEArbyRkeVPnGf7Uhmyyg+kBCjtXaZ+Ha/VDF5EBGTRUQY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIDLSDUjlfbV6acg9Z9UwxB/nE+k8jny8WStBgHAPKzKjAiBDIDH0CQ9iP7qHB/OaSsQ1JEArGhluJhigHPcRJxC14g=="}],"unpackedSize":1054393},"main":"./dist/klaritics.min.js","name":"@deeptaai/klaritics-web-sdk","_from":"file:deeptaai-klaritics-web-sdk-1.0.1.tgz","types":"./dist/klaritics.d.ts","unpkg":"./dist/klaritics.global.js","author":{"name":"Mahesh Pikki","email":"mahesh.p@deeptaai.com"},"module":"./dist/klaritics.mjs","browser":"./dist/klaritics.global.js","exports":{".":{"types":"./dist/klaritics.d.ts","import":"./dist/klaritics.mjs","default":"./dist/klaritics.mjs","require":"./dist/klaritics.min.js"},"./package.json":"./package.json"},"license":"MIT","scripts":{"dev":"pnpm exec tsup --watch","lint":"eslint './src/**/*.ts'","test":"vitest run","build":"pnpm exec tsup"},"version":"1.0.1","_npmUser":{"name":"mahesh.pikki","email":"mahesh.p@deeptaai.com"},"jsdelivr":"./dist/klaritics.global.js","keywords":["klaritics","analytics","web-analytics","session-replay","deeptaai","sdk"],"_resolved":"/tmp/7ceed081c7cf717aa31cbcaa9d6c11a5/deeptaai-klaritics-web-sdk-1.0.1.tgz","_integrity":"sha512-Wea0WC9Vvv5LoXp61DT9T/FXOny8HT3f6+0D2GVHWtbR7WYl5F7oOTMC2yOYbCfiT3Ffs0HPNV3lioMMB9gEZA==","repository":{"url":"git+https://citadel.deeptaai.com/klaritics/development/sdk/web/anthraweb.git","type":"git","directory":"packages/sdk-core"},"_npmVersion":"11.19.0","description":"Klaritics Web Analytics SDK","directories":{},"maintainers":[{"name":"mahesh.pikki","email":"mahesh.p@deeptaai.com"},{"name":"deepta-ai","email":"dev@deeptaai.com"},{"name":"kousikd","email":"kousik.d@deeptaai.com"}],"sideEffects":true,"_nodeVersion":"24.21.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.1","jsdom":"^25.0.1","vitest":"^3.0.0"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/klaritics-web-sdk_1.0.1_1790579202977_0.3341845767240721"}}},"time":{"created":"2026-09-01T11:40:52.398Z","modified":"2026-09-28T07:06:43.253Z","1.0.0":"2026-09-01T11:40:52.870Z","1.0.1":"2026-09-28T07:06:43.067Z"},"author":{"name":"Mahesh Pikki","email":"mahesh.p@deeptaai.com"},"license":"MIT","keywords":["klaritics","analytics","web-analytics","session-replay","deeptaai","sdk"],"repository":{"url":"git+https://citadel.deeptaai.com/klaritics/development/sdk/web/anthraweb.git","type":"git","directory":"packages/sdk-core"},"description":"Klaritics Web Analytics SDK","maintainers":[{"name":"mahesh.pikki","email":"mahesh.p@deeptaai.com"},{"name":"deepta-ai","email":"dev@deeptaai.com"},{"name":"kousikd","email":"kousik.d@deeptaai.com"}],"readme":"# Klaritics Web SDK\n\n`@deeptaai/klaritics-web-sdk` — web analytics for your site.\n\n> **Note:** Contact <dev@deeptaai.com> to get your unique `SITE_ID` and `HOST_NAME`.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [NPM](#npm)\n- [Script tag (Multi Page Applications)](#script-tag-multi-page-applications)\n- [Configuration Options](#configuration-options)\n- [setUserIdentifier](#setuseridentifier)\n- [logPageView](#logpageview)\n- [logAppEvent](#logappevent)\n- [setUserProperties](#setuserproperties)\n- [setSessionProperties](#setsessionproperties)\n- [getDeviceId](#getdeviceid)\n- [startNewSession](#startnewsession)\n- [endSession](#endsession)\n\n## Installation\n\n### NPM\n\n```bash\nnpm install --save @deeptaai/klaritics-web-sdk\n```\n\nImport `Klaritics` and initialize it once, in your application's root component or entry file:\n\n```javascript\nimport Klaritics from \"@deeptaai/klaritics-web-sdk\"; // ES module\n// const Klaritics = require(\"@deeptaai/klaritics-web-sdk\"); // CommonJS\n\nKlaritics.init(\"YOUR_SITE_ID\", \"YOUR_HOST_NAME\", {\n  // configuration options — see below\n});\n```\n\n> If you use a linter, add ignore comments above the import if it flags a side-effectful import.\n\n### Script tag (Multi Page Applications)\n\nAdd the stub snippet to your page `<head>`. It queues calls made before the SDK\nfinishes loading and replays them once ready.\n\n```html\n<script>\n  const _d = new Date();\n  (function (a, n, t) {\n    Klaritics = a.Klaritics || { _q: [], _st: _d };\n    [\n      \"init\",\n      \"setUserIdentifier\",\n      \"setUserProperties\",\n      \"setSessionProperties\",\n      \"logPageView\",\n      \"logAppEvent\",\n      \"setAppVersion\",\n      \"getDeviceId\",\n      \"getSessionId\",\n      \"startNewSession\",\n      \"endSession\"\n    ].forEach(function (m) {\n      Klaritics[m] = function () {\n        this._q.push({ m: m, args: arguments });\n      };\n    });\n  })(window, document, \"script\");\n\n  Klaritics.init(\"YOUR_SITE_ID\", \"YOUR_HOST_NAME\", {\n    // configuration options — see below\n  });\n</script>\n```\n\n## Configuration Options\n\nPassed as the third argument to `Klaritics.init()`. All are optional.\n\n| Option          | Type      | Default   | Description                                                                                               |\n| --------------- | --------- | --------- | --------------------------------------------------------------------------------------------------------- |\n| `debug`         | `boolean` | `false`   | Enables console logging. When `false`, the SDK logs nothing.                                              |\n| `level`         | `string`  | `\"error\"` | Minimum log level to print: `debug` \\| `warn` \\| `error`. Only takes effect when `debug` is `true`.       |\n| `version`       | `string`  | `\"ALL\"`   | Your application's version. Attached to every session and event so analytics can be segmented by release. |\n| `honorDNT`      | `boolean` | `false`   | When `true`, the SDK does not initialize if the browser's \"Do Not Track\" setting is enabled.              |\n| `idle_time_out` | `number`  | `3600`    | Seconds of inactivity after which a new session is started.                                               |\n| `bulk_upload`   | `boolean` | `true`    | `true`: buffer events and upload once the buffer is full. `false`: upload events as they occur.           |\n\n## APIs\n\n### setUserId\n\nAssigns a unique user identifier to the current user.\n\n```javascript\nKlaritics.setUserIdentifier(\"user@example.com\");\n```\n\n---\n\n### logPageView\n\nLogs a page-view event. Call it whenever the user navigates within your site.\n\n```javascript\nKlaritics.logPageView(\"/about.html\"); // URL pathname\n```\n\n---\n\n### logAppEvent\n\nLogs a custom application event with optional properties.\n\n```javascript\nKlaritics.logAppEvent(\n  \"ADD_TO_CART\",\n  {\n    userId: \"user@example.com\",\n    value: 1299,\n    item: \"Sony Head Phone 1201\"\n  },\n  true // force report (report instantly)\n);\n```\n\n---\n\n### setUserProperties\n\nSets attributes on the current user.\n\n```javascript\nKlaritics.setUserProperties({\n  gender: \"Male\",\n  age: 24,\n  isPaidUser: true,\n  creditsLeft: 250\n});\n```\n\n---\n\n### setSessionProperties\n\nSets attributes on the current session.\n\n```javascript\nKlaritics.setSessionProperties({\n  language: \"en\",\n  location: \"Hyderabad\"\n});\n```\n\n---\n\n### getDeviceId\n\nReturns the unique identifier the SDK generated for this device.\n\n```javascript\nconst deviceId = Klaritics.getDeviceId();\n```\n\n---\n\n### startNewSession\n\nStarts a new session if none is active. No-op if a session is already in progress.\n\n```javascript\nKlaritics.startNewSession();\n```\n\n---\n\n### endSession\n\nEnds the active session. After this call every API is a no-op except `startNewSession()`.\n\n```javascript\nKlaritics.endSession();\n```\n","readmeFilename":"README.md"}