{"_id":"@adhamnasr/dashboard","name":"@adhamnasr/dashboard","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@adhamnasr/dashboard","version":"1.0.0","description":"A package for posting logs to dashboard app","keywords":["Dash"],"homepage":"https://github.com/adham-nasr/dashboard-package#readme","bugs":{"url":"https://github.com/adham-nasr/dashboard-package/issues"},"repository":{"type":"git","url":"git+https://github.com/adham-nasr/dashboard-package.git"},"license":"ISC","author":{"name":"Adham"},"type":"module","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"gitHead":"ff3b0d06274e93d26b86c17a9016a7593f043863","_id":"@adhamnasr/dashboard@1.0.0","_nodeVersion":"24.15.0","_npmVersion":"11.12.1","dist":{"integrity":"sha512-VbobeRFgccshzh2j3jw+4gLGylbA+YQbNHCmYGfnkRtbtRefb4DDGuoR7+4WBucUujbRm5ThwomQlNl2Lx3gMw==","shasum":"aa766246006ab0d67e9448754f59b8a71e4357f0","tarball":"https://registry.npmjs.org/@adhamnasr/dashboard/-/dashboard-1.0.0.tgz","fileCount":3,"unpackedSize":3462,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQD/jX+hhnxCss2I6xxGTlRa+ePMOKXUbPlH61HFUyaRLQIhALqVUxJ+w9QxCFTGN6bvLCxd/Y0ekya1I6a3c+TF4qBK"}]},"_npmUser":{"name":"adhamnasr","email":"adhamnasr2000@hotmail.com"},"directories":{},"maintainers":[{"name":"adhamnasr","email":"adhamnasr2000@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/dashboard_1.0.0_1779968894821_0.9423355622691008"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-28T11:48:14.642Z","1.0.0":"2026-05-28T11:48:14.982Z","modified":"2026-05-28T11:48:15.181Z"},"maintainers":[{"name":"adhamnasr","email":"adhamnasr2000@hotmail.com"}],"description":"A package for posting logs to dashboard app","homepage":"https://github.com/adham-nasr/dashboard-package#readme","keywords":["Dash"],"repository":{"type":"git","url":"git+https://github.com/adham-nasr/dashboard-package.git"},"author":{"name":"Adham"},"bugs":{"url":"https://github.com/adham-nasr/dashboard-package/issues"},"license":"ISC","readme":"# @adhamnasr/dashboard\r\n\r\nA lightweight logger package for posting event and diagnostic logs to a centralized dashboard application.\r\n\r\n## Features\r\n\r\n- Initialize with an API key and application name\r\n- Reads `baseUrl` from a local `.env` file\r\n- Sends log payloads to `POST /api/applications/:appName/logs`\r\n- Returns the raw fetch response for success or error handling\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @adhamnasr/dashboard\r\n```\r\n\r\n## Usage\r\n\r\nCreate a `.env` file in the root of your project with the dashboard API base URL:\r\n\r\n```env\r\nbaseUrl=https://your-dashboard.example.com\r\n```\r\n\r\nThen use the package like this:\r\n\r\n```js\r\nimport Logger from \"@adhamnasr/dashboard\";\r\n\r\nLogger.init(\"YOUR_API_KEY\", \"my-app-name\");\r\n\r\nconst logEntry = {\r\n  level: \"info\",\r\n  message: \"User signed in\",\r\n  userId: \"123\",\r\n  timestamp: new Date().toISOString(),\r\n};\r\n\r\nconst response = await Logger.log(logEntry);\r\nconsole.log(response.status, await response.text());\r\n```\r\n\r\n## API\r\n\r\n### `Logger.init(apiKey, appName)`\r\n\r\nInitializes the logger.\r\n\r\n- `apiKey` (string): Bearer token used for authorization.\r\n- `appName` (string): Application name used in the log endpoint path.\r\n\r\nThis method reads `baseUrl` from `.env` using Node's `process` utilities.\r\n\r\n### `Logger.log(data)`\r\n\r\nSends a log payload to the dashboard.\r\n\r\n- `data` (object): JSON-serializable log data.\r\n\r\nReturns the fetch response or an error object if the request fails.\r\n\r\n## Notes\r\n\r\n- `type` is set to `module` in `package.json`, so use ES module imports.\r\n- Make sure `.env` contains a valid `baseUrl` before calling `Logger.init()`.\r\n\r\n## License\r\n\r\nISC\r\n\r\n## Contributing\r\n\r\nIf you want, I can also expand this README with:\r\n\r\n- a detailed log schema example\r\n- recommended error handling patterns\r\n- env file example for auth and staging/production\r\n- package publishing or upgrade instructions\r\n","readmeFilename":"README.md","_rev":"1-b75b44fde0b60e56695abfdc7b8b59b9"}