{"_id":"survaii-session-stream","_rev":"64-91c95a8360d3dcc64068eeaf817e6c71","name":"survaii-session-stream","description":"Survaii SessionStream is an advanced session recording and replay tool designed to help businesses and developers gain deep insights into user behavior. By capturing and replaying user interactions, ReplayView provides a comprehensive view of how users en","dist-tags":{"latest":"0.0.9"},"versions":{"0.0.4":{"name":"survaii-session-stream","version":"0.0.4","author":{"name":"Soma BINI"},"license":"ISC","_id":"survaii-session-stream@0.0.4","maintainers":[{"name":"somabini","email":"soma@survaii.io"}],"homepage":"https://gitlab.com/survaii-frontend/survaii-session-stream#readme","bugs":{"url":"https://gitlab.com/survaii-frontend/survaii-session-stream/issues"},"dist":{"shasum":"db1a4938a4ff8fc22411755d15eb3385f378561d","tarball":"https://registry.npmjs.org/survaii-session-stream/-/survaii-session-stream-0.0.4.tgz","fileCount":9,"integrity":"sha512-1GMXuDIKluUT7zlHa6zOSCVj7ok1gwef/MxeyI0nphZFsld1hnBkpvol1TWy+eT+VPtOgcTnim7uQxW4ST/gPA==","signatures":[{"sig":"MEYCIQDxkmrKJ4isNRzGafVz4F3XPT1FcSSZ4UqmR5WKCIgB+AIhAJGvEQr6taPeXy22+tJ0OjIgrxTH2ksPDo/3ISgUMrXO","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1680054},"main":"dist/bundle.cjs.js","type":"module","types":"dist/types/index.d.ts","module":"dist/bundle.esm.js","browser":"dist/bundle.umd.js","exports":{".":{"umd":"./dist/bundle.umd.js","types":"./dist/types/index.d.ts","import":"./dist/bundle.esm.js","require":"./dist/bundle.cjs.js"}},"gitHead":"b8782e5e3030bf7ee10a107cd4e57d10c4115caa","scripts":{"lint":"eslint 'src/**/*.{js,ts}'","test":"echo \"Error: no test specified\" && exit 1","build":"webpack --config webpack.config.js","format":"prettier --write 'src/**/*.{js,ts}'","build:rollup":"rollup -c rollup.config.mjs"},"_npmUser":{"name":"somabini","email":"soma@survaii.io"},"repository":{"url":"git+https://gitlab.com/survaii-frontend/survaii-session-stream.git","type":"git"},"_npmVersion":"10.3.0","description":"Survaii SessionStream is an advanced session recording and replay tool designed to help businesses and developers gain deep insights into user behavior. By capturing and replaying user interactions, ReplayView provides a comprehensive view of how users en","directories":{},"_nodeVersion":"20.10.0","dependencies":{"tmp":"^0.2.3","pako":"^2.1.0","uuid":"^9.0.1","axios":"^1.7.2","rrweb":"^2.0.0-alpha.4","file-saver":"^2.0.5","@types/uuid":"^9.0.8","stream-http":"^3.2.0","ua-parser-js":"^1.0.38","path-browserify":"^1.0.1","https-browserify":"^1.0.0","@types/file-saver":"^2.0.7","crypto-browserify":"^3.12.0","stream-browserify":"^3.0.0","@types/ua-parser-js":"^0.7.39","node-polyfill-webpack-plugin":"^4.0.0","rollup-plugin-node-polyfills":"^0.2.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^9.3.0","rollup":"^4.18.0","globals":"^15.3.0","ts-node":"^10.9.2","webpack":"^5.91.0","prettier":"^3.2.5","ts-loader":"^9.5.1","@eslint/js":"^9.3.0","@types/tmp":"^0.2.6","typescript":"^5.4.5","@types/node":"^20.12.13","@types/pako":"^2.0.3","webpack-cli":"^5.1.4","@types/node-fetch":"^2.6.11","typescript-eslint":"^7.11.0","rollup-plugin-terser":"^7.0.2","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@rollup/plugin-commonjs":"^25.0.8","@rollup/plugin-typescript":"^11.1.6","@typescript-eslint/parser":"^7.11.0","@rollup/plugin-node-resolve":"^15.2.3","@typescript-eslint/eslint-plugin":"^7.11.0"},"_npmOperationalInternal":{"tmp":"tmp/survaii-session-stream_0.0.4_1718824493213_0.5016091360922099","host":"s3://npm-registry-packages"}},"0.0.8":{"name":"survaii-session-stream","version":"0.0.8","author":{"name":"Soma BINI"},"license":"ISC","_id":"survaii-session-stream@0.0.8","maintainers":[{"name":"somabini","email":"soma@survaii.io"}],"homepage":"https://gitlab.com/survaii-frontend/survaii-session-stream#readme","bugs":{"url":"https://gitlab.com/survaii-frontend/survaii-session-stream/issues"},"dist":{"shasum":"1e08345c66e98052a95e2610a316ee8b0f53ba56","tarball":"https://registry.npmjs.org/survaii-session-stream/-/survaii-session-stream-0.0.8.tgz","fileCount":9,"integrity":"sha512-yMNpzOD3lCzIfBIkmqEnk7P2982uHvcJbuA52XEaQWffGb9ncEWTEdfICSlqSTiBw12rmCxtyO9HLHZwiRIrFg==","signatures":[{"sig":"MEYCIQCogL7owTL9H1Bey7HsuUeSKfKye+ws+4MP34E/ymI3+gIhAOlYj2TBbP9/EVpDa3aj7Gp2x9M8Prl63Ez+IK2WX+NE","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1680900},"main":"dist/bundle.cjs.js","type":"module","types":"dist/types/index.d.ts","module":"dist/bundle.esm.js","browser":"dist/bundle.umd.js","exports":{".":{"umd":"./dist/bundle.umd.js","types":"./dist/types/index.d.ts","import":"./dist/bundle.esm.js","require":"./dist/bundle.cjs.js"}},"gitHead":"b8782e5e3030bf7ee10a107cd4e57d10c4115caa","scripts":{"lint":"eslint 'src/**/*.{js,ts}'","test":"echo \"Error: no test specified\" && exit 1","build":"webpack --config webpack.config.js","format":"prettier --write 'src/**/*.{js,ts}'","build:rollup":"rollup -c rollup.config.mjs"},"_npmUser":{"name":"somabini","email":"soma@survaii.io"},"repository":{"url":"git+https://gitlab.com/survaii-frontend/survaii-session-stream.git","type":"git"},"_npmVersion":"10.3.0","description":"Survaii SessionStream is an advanced session recording and replay tool designed to help businesses and developers gain deep insights into user behavior. By capturing and replaying user interactions, ReplayView provides a comprehensive view of how users en","directories":{},"_nodeVersion":"20.10.0","dependencies":{"tmp":"^0.2.3","pako":"^2.1.0","uuid":"^9.0.1","axios":"^1.7.2","rrweb":"^2.0.0-alpha.4","file-saver":"^2.0.5","@types/uuid":"^9.0.8","stream-http":"^3.2.0","ua-parser-js":"^1.0.38","path-browserify":"^1.0.1","https-browserify":"^1.0.0","@types/file-saver":"^2.0.7","crypto-browserify":"^3.12.0","stream-browserify":"^3.0.0","@types/ua-parser-js":"^0.7.39","node-polyfill-webpack-plugin":"^4.0.0","rollup-plugin-node-polyfills":"^0.2.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^9.3.0","rollup":"^4.18.0","globals":"^15.3.0","ts-node":"^10.9.2","webpack":"^5.91.0","prettier":"^3.2.5","ts-loader":"^9.5.1","@eslint/js":"^9.3.0","@types/tmp":"^0.2.6","typescript":"^5.4.5","@types/node":"^20.12.13","@types/pako":"^2.0.3","webpack-cli":"^5.1.4","@types/node-fetch":"^2.6.11","typescript-eslint":"^7.11.0","rollup-plugin-terser":"^7.0.2","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@rollup/plugin-commonjs":"^25.0.8","@rollup/plugin-typescript":"^11.1.6","@typescript-eslint/parser":"^7.11.0","@rollup/plugin-node-resolve":"^15.2.3","@typescript-eslint/eslint-plugin":"^7.11.0"},"_npmOperationalInternal":{"tmp":"tmp/survaii-session-stream_0.0.8_1718862752426_0.11745184236458761","host":"s3://npm-registry-packages"}},"0.0.9":{"name":"survaii-session-stream","version":"0.0.9","description":"Survaii SessionStream is an advanced session recording and replay tool designed to help businesses and developers gain deep insights into user behavior. By capturing and replaying user interactions, ReplayView provides a comprehensive view of how users en","main":"dist/bundle.cjs.js","module":"dist/bundle.esm.js","browser":"dist/bundle.umd.js","types":"dist/types/index.d.ts","type":"module","exports":{".":{"import":"./dist/bundle.esm.js","require":"./dist/bundle.cjs.js","umd":"./dist/bundle.umd.js","types":"./dist/types/index.d.ts"}},"scripts":{"build:rollup":"rollup -c rollup.config.mjs","build":"webpack --config webpack.config.js","lint":"eslint 'src/**/*.{js,ts}'","format":"prettier --write 'src/**/*.{js,ts}'","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://gitlab.com/survaii-frontend/survaii-session-stream.git"},"author":{"name":"Soma BINI"},"license":"ISC","bugs":{"url":"https://gitlab.com/survaii-frontend/survaii-session-stream/issues"},"homepage":"https://gitlab.com/survaii-frontend/survaii-session-stream#readme","devDependencies":{"@eslint/js":"^9.3.0","@rollup/plugin-commonjs":"^25.0.8","@rollup/plugin-node-resolve":"^15.2.3","@rollup/plugin-typescript":"^11.1.6","@types/node":"^20.12.13","@types/node-fetch":"^2.6.11","@types/pako":"^2.0.3","@types/tmp":"^0.2.6","@typescript-eslint/eslint-plugin":"^7.11.0","@typescript-eslint/parser":"^7.11.0","eslint":"^9.3.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","globals":"^15.3.0","prettier":"^3.2.5","rollup":"^4.18.0","rollup-plugin-terser":"^7.0.2","ts-loader":"^9.5.1","ts-node":"^10.9.2","typescript":"^5.4.5","typescript-eslint":"^7.11.0","webpack":"^5.91.0","webpack-cli":"^5.1.4"},"dependencies":{"@types/file-saver":"^2.0.7","@types/ua-parser-js":"^0.7.39","@types/uuid":"^9.0.8","axios":"^1.7.2","crypto-browserify":"^3.12.0","file-saver":"^2.0.5","https-browserify":"^1.0.0","node-polyfill-webpack-plugin":"^4.0.0","pako":"^2.1.0","path-browserify":"^1.0.1","rollup-plugin-node-polyfills":"^0.2.1","rrweb":"^2.0.0-alpha.4","stream-browserify":"^3.0.0","stream-http":"^3.2.0","tmp":"^0.2.3","ua-parser-js":"^1.0.38","uuid":"^9.0.1"},"_id":"survaii-session-stream@0.0.9","gitHead":"7a039e9b458a6f9e7ea1b79e09e9f38a671bd3a7","_nodeVersion":"20.10.0","_npmVersion":"10.3.0","dist":{"integrity":"sha512-xZ51nmiJvFznQMDyj4zTXY+FAsOengsyhdd8sjrZ+H7KrN4M2bqbZlHy32WbM/aXoXieWdYDBmUNYKnGpcLevg==","shasum":"0ffd268983209875c5d8fcfde87b8de201521e1a","tarball":"https://registry.npmjs.org/survaii-session-stream/-/survaii-session-stream-0.0.9.tgz","fileCount":9,"unpackedSize":1686116,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGroSUTV14ycBX4VJ6FvwWny2FWgpjrIk4Zv4B6lOhrcAiBJX3LTw1HL8jpGuixH86V/ii1E5atK/MnWeRUDR8/n9Q=="}]},"_npmUser":{"name":"somabini","email":"soma@survaii.io"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/survaii-session-stream_0.0.9_1719923113298_0.17286470316889568"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-16T10:25:28.693Z","modified":"2024-07-02T12:25:13.857Z","1.0.0":"2024-06-02T14:12:13.600Z","1.0.1":"2024-06-02T14:20:34.145Z","1.0.2":"2024-06-02T14:31:14.966Z","1.0.3":"2024-06-02T14:55:44.827Z","1.0.4":"2024-06-02T15:02:20.467Z","1.0.5":"2024-06-02T15:05:23.815Z","1.0.6":"2024-06-02T15:28:13.752Z","1.0.0-beta-dev":"2024-06-16T10:25:28.921Z","1.1.0-beta-dev":"2024-06-16T10:49:58.955Z","1.2.0-beta-dev":"2024-06-17T09:32:06.190Z","1.3.0-beta-dev":"2024-06-17T10:00:52.391Z","1.4.0-beta-dev":"2024-06-17T10:27:06.146Z","1.5.0-beta-dev":"2024-06-17T10:44:50.183Z","1.6.0-beta-dev":"2024-06-17T10:55:36.077Z","1.7.0-beta-dev":"2024-06-17T11:03:29.670Z","1.8.0-beta-dev":"2024-06-17T11:16:10.416Z","1.9.0-beta-dev":"2024-06-17T11:20:34.184Z","1.10.0-beta-dev":"2024-06-17T11:49:15.935Z","1.11.0-beta-dev":"2024-06-17T12:09:19.316Z","1.12.0-beta-dev":"2024-06-17T12:25:07.193Z","0.0.1":"2024-06-18T10:29:03.325Z","1.13.0-beta-dev":"2024-06-19T13:22:42.068Z","1.14.0-beta-dev":"2024-06-19T13:28:21.001Z","1.15.0-beta-dev":"2024-06-19T16:02:04.900Z","1.16.0-beta-dev":"2024-06-19T16:03:15.805Z","1.16.1-beta-dev":"2024-06-19T16:04:30.563Z","1.16.2-beta-dev":"2024-06-19T16:13:18.582Z","1.16.3-beta-dev":"2024-06-19T16:25:26.314Z","0.0.2":"2024-06-19T16:33:12.962Z","0.0.3":"2024-06-19T18:27:48.477Z","0.0.4":"2024-06-19T19:14:53.437Z","0.0.5-dev":"2024-06-19T21:04:36.944Z","0.0.6-dev":"2024-06-19T21:19:02.750Z","0.0.7-dev":"2024-06-19T21:31:35.097Z","0.0.8-dev":"2024-06-20T05:43:27.761Z","0.0.8":"2024-06-20T05:52:32.660Z","0.0.9":"2024-07-02T12:25:13.708Z"},"maintainers":[{"name":"somabini","email":"soma@survaii.io"}],"author":{"name":"Soma BINI"},"repository":{"type":"git","url":"git+https://gitlab.com/survaii-frontend/survaii-session-stream.git"},"license":"ISC","homepage":"https://gitlab.com/survaii-frontend/survaii-session-stream#readme","bugs":{"url":"https://gitlab.com/survaii-frontend/survaii-session-stream/issues"},"readme":"# Survaii Session Stream\n\nSurvaii Session Stream allows you to record user sessions effortlessly, capturing valuable insights into user interactions with your application.\n\n## Getting Started\n\nFollow these simple steps to integrate and use Survaii Session Stream in your project.\n\n### Prerequisites\n\n1. **AppKey**: Ensure you have an AppKey from Survaii.\n\n### Installation\n\nInstall the Survaii Session Stream library via npm:\n\n```bash\nnpm install survaii-session-stream\n```\n\n### Usage\n\n1. **Import the Library**:\n\n   ```javascript\n   import { SurvaiiSessionStream } from 'survaii-session-stream';\n   ```\n\n2. **Initialize the Recorder**:\n\n   Call the `init` function to initialize the recorder. The `init` function takes four parameters, with the `ID`, `Interval` and `MaskAllInputs` parameters being optional:\n    - **AppKey**: Your Survaii AppKey.\n    - **ID**: (Optional) A unique identifier for the session (e.g., an email or a database ID). This is useful for recording sessions of authenticated users.\n    - **Interval**: (Optional) The interval in milliseconds to capture small chunks of the session (default is `30000` ms). This ensures you don't miss anything even if the user exits your app abruptly.\n    - **MaskAllInputs**: (Optional) When set to true, all input fields will have their values masked to prevent sensitive information from being recorded. This is useful for maintaining privacy and security.\n\n   ```javascript\n   SurvaiiSessionStream.init(\n   'your-app-key', // Replace with your AppKey\n     'unique-user-id', // Optional: Replace with your unique identifier\n     30000, // Optional: Adjust the interval as needed\n     true, // Optional: Mask all inputs\n   );\n   ```\n\n3. **Start Recording**:\n\n   To start recording the session, call the `startRecording` function:\n\n   ```javascript\n   SurvaiiSessionStream.startRecording();\n   ```\n\n4. **Stop Recording**:\n\n   If you need to stop recording the session, call the `stopRecording` function:\n\n   ```javascript\n   SurvaiiSessionStream.stopRecording();\n   ```\n\n### Example\n\nHere is a complete example of how to use Survaii Session Stream:\n\n```javascript\nimport { SurvaiiSessionStream } from 'survaii-session-stream';\n\n// Initialize the recorder\nSurvaiiSessionStream.init({\n  id: 'user@example.com', // Optional: Replace with a unique identifier\n  interval: 30000, // Optional: Adjust the interval as needed\n  appKey: 'your-app-key', // Replace with your AppKey\n});\n\n// Start recording the session\nSurvaiiSessionStream.startRecording();\n\n// Optionally, stop recording the session when needed\n// SurvaiiSessionStream.stopRecording();\n```\n\n### Conclusion\n\nThat's it! You are now ready to start recording user sessions with Survaii Session Stream. This will help you gain valuable insights into how users interact with your application, allowing you to make informed decisions to improve the user experience.\n\nIf you have any issues or need further assistance, please contact us at [contact@survaii.io](mailto:contact@survaii.io).","readmeFilename":"README.md"}