{"_id":"@atmosx/pulse-point-wrapper","_rev":"4-f98ae943d9558b3b8e8e9e2f5a3f66cc","name":"@atmosx/pulse-point-wrapper","dist-tags":{"latest":"1.0.40"},"versions":{"1.0.37":{"name":"@atmosx/pulse-point-wrapper","version":"1.0.37","keywords":["PulsePoint","911 Alerts","Public Safety","TypeScript","Parser","JavaScript","CommonJS","ESM"],"author":{"name":"k3yomi, StarflightWx, CJ Ziegler"},"license":"MIT","_id":"@atmosx/pulse-point-wrapper@1.0.37","maintainers":[{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"}],"homepage":"https://github.com/AtmosphericX/pulse-point-wrapper#readme","bugs":{"url":"https://github.com/AtmosphericX/pulse-point-wrapper/issues"},"dist":{"shasum":"17a48bd80eb5bf716eaff1e4bc56a7f9ad40731c","tarball":"https://registry.npmjs.org/@atmosx/pulse-point-wrapper/-/pulse-point-wrapper-1.0.37.tgz","fileCount":17,"integrity":"sha512-1NGieYk0KNFnZ4QhF9DTgSuO7+xcYUw9rs3zAQVYX4G/sxAIqF0jIPLiLQVzjATa3njumAq/qbJExlbjOXdHjQ==","signatures":[{"sig":"MEUCIQDS2U0lDZWgmOifWu9KmhsEA1MXp2rIrKYluQAGNaw3SAIgLedY6umsmmG85/sas8Nwsoh1oEh3SQ/QpFEK0ZraZbA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":77529},"main":"dist/cjs/index.cjs","module":"dist/esm/index.mjs","gitHead":"723ca839cc7a113ab2874607dc411c9fbbd5733f","scripts":{"build":"tsup && cd ./test && node ./index.js","start":"cd ./test && node ./index.js","publish":"tsup && npm publish --access public","publish-beta":"tsup && npm publish --tag beta --access public"},"_npmUser":{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"},"repository":{"url":"git+https://github.com/AtmosphericX/pulse-point-wrapper.git","type":"git","branch":"main"},"_npmVersion":"10.7.0","description":"AtmosphericX PulsePoint - Built for standalone and Project AtmosphericX Integration.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"axios":"1.13.4","croner":"10.0.1","crypto-js":"4.2.0","typescript":"5.9.3"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"8.5.1","@types/node":"25.2.0"},"_npmOperationalInternal":{"tmp":"tmp/pulse-point-wrapper_1.0.37_1774727736885_0.3384412677890878","host":"s3://npm-registry-packages-npm-production"}},"1.0.38":{"name":"@atmosx/pulse-point-wrapper","version":"1.0.38","keywords":["PulsePoint","911 Alerts","Public Safety","TypeScript","Parser","JavaScript","CommonJS","ESM"],"author":{"name":"k3yomi, StarflightWx, CJ Ziegler"},"license":"MIT","_id":"@atmosx/pulse-point-wrapper@1.0.38","maintainers":[{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"}],"homepage":"https://github.com/AtmosphericX/pulse-point-wrapper#readme","bugs":{"url":"https://github.com/AtmosphericX/pulse-point-wrapper/issues"},"dist":{"shasum":"3658d2f007cc6de577a0f580f6dab219c4d05f83","tarball":"https://registry.npmjs.org/@atmosx/pulse-point-wrapper/-/pulse-point-wrapper-1.0.38.tgz","fileCount":17,"integrity":"sha512-X7qw+A3t+tHmRvxuI9zkm36rBvq7Jve2qyJuAee6+HBwmv+gRwPY+pyepjTVT9maDZf3+zhq7BZRu3W24fzwMg==","signatures":[{"sig":"MEUCIA0rTlC+7w2BvXubc8+Bo85ONCjuy8Zl/GVh/I1WN8pnAiEAn1zLc+OfjR0HI0wYiQp/wJ8gWdb4uNZDot+96Z8tBpw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":77537},"main":"dist/cjs/index.cjs","module":"dist/esm/index.mjs","gitHead":"6a36afd0d241a5b7aeaedb598045e817e2d303d7","scripts":{"build":"tsup && cd ./test && node ./index.js","start":"cd ./test && node ./index.js","publish":"tsup && npm publish --access public","publish-beta":"tsup && npm publish --tag beta --access public"},"_npmUser":{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"},"repository":{"url":"git+https://github.com/AtmosphericX/pulse-point-wrapper.git","type":"git","branch":"main"},"_npmVersion":"10.7.0","description":"AtmosphericX PulsePoint - Built for standalone and Project AtmosphericX Integration.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"axios":"1.13.4","croner":"10.0.1","crypto-js":"4.2.0","typescript":"5.9.3"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"8.5.1","@types/node":"25.2.0"},"_npmOperationalInternal":{"tmp":"tmp/pulse-point-wrapper_1.0.38_1774735032090_0.7275350894821129","host":"s3://npm-registry-packages-npm-production"}},"1.0.39":{"name":"@atmosx/pulse-point-wrapper","version":"1.0.39","keywords":["PulsePoint","911 Alerts","Public Safety","TypeScript","Parser","JavaScript","CommonJS","ESM"],"author":{"name":"k3yomi, StarflightWx, CJ Ziegler"},"license":"MIT","_id":"@atmosx/pulse-point-wrapper@1.0.39","maintainers":[{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"}],"homepage":"https://github.com/AtmosphericX/pulse-point-wrapper#readme","bugs":{"url":"https://github.com/AtmosphericX/pulse-point-wrapper/issues"},"dist":{"shasum":"298fdefedc5b791d07bd2456de01817a84401baa","tarball":"https://registry.npmjs.org/@atmosx/pulse-point-wrapper/-/pulse-point-wrapper-1.0.39.tgz","fileCount":18,"integrity":"sha512-8dOM4RW8YmY0abNTETAhhEwSyeLas49+GVZAxMhM5IuZDGBxRL+l+niSHwVJEsqiER8cOvPT5/fBkjIUwEifSA==","signatures":[{"sig":"MEUCIFaF2sd6tNxKVPak14wyPkngL+t/Sn5gmJS3LAHx+5jwAiEAuXUZQBDd7oGS+1pfXB71LrAQ5O/F8IOvu1aSk4ge1GA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":78245},"main":"dist/cjs/index.cjs","module":"dist/esm/index.mjs","gitHead":"2e4a5d59086c155be826f7238fbaf717fab872da","scripts":{"build":"tsup && cd ./test && node ./index.js","start":"cd ./test && node ./index.js","publish":"tsup && npm publish --access public","publish-beta":"tsup && npm publish --tag beta --access public"},"_npmUser":{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"},"repository":{"url":"git+https://github.com/AtmosphericX/pulse-point-wrapper.git","type":"git","branch":"main"},"_npmVersion":"10.7.0","description":"AtmosphericX PulsePoint - Built for standalone and Project AtmosphericX Integration.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"croner":"10.0.1","crypto-js":"4.2.0","typescript":"5.9.3"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"8.5.1","@types/node":"25.2.0"},"_npmOperationalInternal":{"tmp":"tmp/pulse-point-wrapper_1.0.39_1778430740977_0.5012117680101047","host":"s3://npm-registry-packages-npm-production"}},"1.0.40":{"name":"@atmosx/pulse-point-wrapper","version":"1.0.40","description":"AtmosphericX PulsePoint - Built for standalone and Project AtmosphericX Integration.","main":"dist/cjs/index.cjs","module":"dist/esm/index.mjs","repository":{"type":"git","url":"git+https://github.com/AtmosphericX/pulse-point-wrapper.git","branch":"main"},"scripts":{"start":"cd ./test && node ./index.js","build":"tsup && cd ./test && node ./index.js","publish":"tsup && npm publish --access public","publish-beta":"tsup && npm publish --tag beta --access public"},"keywords":["PulsePoint","911 Alerts","Public Safety","TypeScript","Parser","JavaScript","CommonJS","ESM"],"author":{"name":"k3yomi, StarflightWx, CJ Ziegler"},"license":"MIT","bugs":{"url":"https://github.com/AtmosphericX/pulse-point-wrapper/issues"},"homepage":"https://github.com/AtmosphericX/pulse-point-wrapper#readme","dependencies":{"croner":"10.0.1","typescript":"5.9.3","crypto-js":"4.2.0"},"devDependencies":{"@types/node":"25.2.0","tsup":"8.5.1"},"_id":"@atmosx/pulse-point-wrapper@1.0.40","gitHead":"2d4ca3d32dae9e047d3cc70014eb14e630f1cb16","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-Mai4tBtCoFaOxfDEDXABAitplNUdqE+yR7MBSXw3FUtG5I7buqoaLit8r5BBlrWPnM+BLeNonZHtFj5b5rc7vQ==","shasum":"7ed30dcc7b68c43693785f7aae2a675da1a0c35f","tarball":"https://registry.npmjs.org/@atmosx/pulse-point-wrapper/-/pulse-point-wrapper-1.0.40.tgz","fileCount":18,"unpackedSize":77864,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHMriMaYHMhjZLaejzOM/UNG4rvWMj68utLrQdmPUEa3AiAVddR0tAB85IvoA56dwkBkof0I7dH6uj3fUnyKevvkwA=="}]},"_npmUser":{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"},"directories":{},"maintainers":[{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/pulse-point-wrapper_1.0.40_1783210040772_0.6646958933412785"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-28T19:55:36.790Z","modified":"2026-07-05T00:07:21.044Z","1.0.37":"2026-03-28T19:55:37.052Z","1.0.38":"2026-03-28T21:57:12.303Z","1.0.39":"2026-05-10T16:32:21.131Z","1.0.40":"2026-07-05T00:07:20.915Z"},"bugs":{"url":"https://github.com/AtmosphericX/pulse-point-wrapper/issues"},"author":{"name":"k3yomi, StarflightWx, CJ Ziegler"},"license":"MIT","homepage":"https://github.com/AtmosphericX/pulse-point-wrapper#readme","keywords":["PulsePoint","911 Alerts","Public Safety","TypeScript","Parser","JavaScript","CommonJS","ESM"],"repository":{"type":"git","url":"git+https://github.com/AtmosphericX/pulse-point-wrapper.git","branch":"main"},"description":"AtmosphericX PulsePoint - Built for standalone and Project AtmosphericX Integration.","maintainers":[{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"}],"readme":"\n<h1 style='font-size: 65px'; align=\"center\">🚒 AtmosphericX - PulsePoint Wrapper 🚨</h1>\n<div align=\"center\">\n  \t<p align = \"center\">PulsePoint is a public emergency response system used by fire departments, EMS agencies, and dispatch centers to share live incident information with the public. This module provides a way to poll and decrypt the data provided by PulsePoint. Please keep in mind that this module is unofficial and not endorsed by PulsePoint or its parent organization. This module is primarily intended for use with the https://github.com/k3yomi/AtmosphericX project.</small></p>\n  \t<p align = \"center\">Documentation written by @k3yomi</p>\n\t<div align=\"center\" style=\"border: none;\">\n\t\t<img alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/AtmosphericX/pulse-point-wrapper\">\n\t\t<img alt=\"GitHub forks\" src=\"https://img.shields.io/github/forks/AtmosphericX/pulse-point-wrapper\">\n\t\t<img alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/AtmosphericX/pulse-point-wrapper\">\n\t\t<img alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/AtmosphericX/pulse-point-wrapper\">\n\t</div>\n</div>\n\n\n## Installation (NPM)\n```bash\nnpm install @atmosx/pulse-point-wrapper\n```\n\n## Example Usage\n```js\nconst { PulsePoint } = require(`@atmosx/pulse-point-wrapper`); // CJS\nimport { PulsePoint } from `@atmosx/pulse-point-wrapper`; // ESM\n\nconst pulse = new PulsePoint({\n    key: `YOUR_PASSWORD_KEY_FOR_DECRYPTION`, // Not provided by PulsePoint, you must obtain this key yourself.\n    interval: 30, // Polling interval in seconds (default: 60)\n    jorunal: true, // Enable journaling for debug messages (default: true)\n    filtering: {\n        events: [\"Mutual Aid\", \"Structure Fire\"], // Leave empty to allow all event types\n        agencies: [\"FIRE5678\", \"EMS1234\"], // This must be populated, leaving empty will NOT return any data.\n    }\n})\n```\n\n## Decryption Key\nBy default, PulsePoint encrypts its data using client-side encryption. To decrypt the data, you need to provide a decryption key when initializing the module. This key is not provided by PulsePoint, and you must obtain it yourself. This module is really only to be used by those who already have access to the decryption key so they can integrate PulsePoint data into their own applications.\nPlease ensure you comply with all relevant laws and regulations regarding the use of this data as I do not take any responsibility for how you use this module or the data it retrieves.\n\n\n## Events and Listeners\n\n### Event `onIncidentUpdate`\nThis event listener is triggered whenever there is an update or new event in the incident data. The callback function receives an array of the incident objects and can be used to process or display the data as needed.\n\n```js\npulse.on(`onIncidentUpdate`, (incident) => {\n    console.log(incident);\n});\n```\n\n### Event `onIncidentClosed`\nThis event listener is triggered when an incident is closed. When received, you should dispose of the incident data to maintain an accurate live view of active events.\n\n```js\npulse.on(`onIncidentClosed`, (incidentID) => {\n    console.log(incidentID);\n});\n```\n\n### Event `Log`\nThe log listener captures log messages generated during the module's operation. This can be useful for debugging or monitoring the module's activity. This is mostly used when journaling is disabled. Otherwise, log messages will be displayed in the console directly.\n\n```js \npulse.on(`log`, (message) => {\n    console.log(`[Log]: ${message}`);\n});\n```\n\n## Callbacks and Functions\n\n### Function `getAvailableAgencies()`\nThis asynchronous function retrieves a list of available agencies from the PulsePoint data source. It returns an array of agency identifiers that can be used for filtering or other purposes.\n\n```js\npulse.getAvailableAgencies().then((agencies) => {\n    console.log(agencies);\n});\n```\n\n### Function `getAvailableEvents()`\nThis function retrieves a list of available event types from the PulsePoint data source. It returns\nan array of event type strings that can be used for filtering or other purposes.\n\n```js\npulse.getAvailableEvents()\n```\n\n### Function `setSettings({})`\nThis function allows you to update the module's settings dynamically. You can change parameters such as the polling interval, journaling preference, and filtering options.\n\n```js\npulse.setSettings({\n    interval: 45, // Update polling interval to 45 seconds\n    journaling: false, // Disable journaling\n    filtering: {\n        events: [\"Medical Emergency\"], // Update event filtering\n        agencies: [\"FIRE1234\"], // Update agency filtering\n    }\n});\n```\n\n### Function `stop()`\nThis function stops the polling process. It can be used when you want to temporarily halt data retrieval without destroying the module instance.\n\n```js\npulse.stop();\n```\n\n## References\n[PulsePoint](https://www.pulsepoint.org/) |\n[Documentation](https://atmosphericx.scriptkitty.cafe/documentation) |\n[Discord Server](https://atmosphericx-discord.scriptkitty.cafe) |\n[Project Board](https://github.com/users/AtmosphericX/projects/2) |\\\n[Code of Conduct](/CODE_OF_CONDUCT.md) |\n[Contributing](/CONTRIBUTING.md) |\n[License](/LICENSE) | \n[Security](/SECURITY.md) | \n[Changelogs](/CHANGELOGS.md) |\n\n## Acknowledgements\n- [CJ Ziegler](https://www.youtube.com/channel/UCx_mcHxMvZ8PBmVTtg6Ddtw)\n    - For inspiring me to create this module for storm spotting and night crawling streams.\n    - Storm Spotter @ AtmosphericX\n- [k3yomi](https://github.com/k3yomi)\n    - Lead developer @ AtmosphericX and maintainer of this module.\n- [StarflightWx](https://x.com/starflightVR)\n    - For testing and providing feedback (Co-Developer and Spotter @ AtmosphericX)","readmeFilename":"README.md"}