{"_id":"@bueno-analytics/next-actuator","_rev":"2-b133efbf7ad2d2b2595b5ff9829a3d31","name":"@bueno-analytics/next-actuator","dist-tags":{"next":"0.0.0-semantic-release","latest":"2.0.0"},"versions":{"0.0.0-semantic-release":{"name":"@bueno-analytics/next-actuator","version":"0.0.0-semantic-release","keywords":["actuator","next.js","health-check","ping","metrics","kubernetes"],"author":{"name":"Jack Cuthbert","email":"jckcthbrt@gmail.com"},"license":"MIT","_id":"@bueno-analytics/next-actuator@0.0.0-semantic-release","maintainers":[{"name":"jckcthbrt","email":"jckcthbrt@gmail.com"},{"name":"bencook","email":"benpetercook@gmail.com"}],"homepage":"https://github.com/bueno-analytics/next-actuator#readme","bugs":{"url":"https://github.com/bueno-analytics/next-actuator/issues"},"dist":{"shasum":"39118f2de6a23236fbcaad6a0cbe03957c50c170","tarball":"https://registry.npmjs.org/@bueno-analytics/next-actuator/-/next-actuator-0.0.0-semantic-release.tgz","fileCount":7,"integrity":"sha512-P6uf3ZRKN6DweS7uPdUUf+MD1j/VQeBbaT+h6BqO+LpE1LZdnB9hOEKz41LChNyMQp5xUAyXJcd8/YIwIGBW7Q==","signatures":[{"sig":"MEQCIFQcRh12qxqPxbBBllDI+2aBq4o0llf3D+k6AkbuURHJAiBRACjVARfYXbcDdHUpm1Y6Nob97PqA6CUK3LOXGzDUcQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":7779},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.js","engines":{"node":">=16.0.0"},"gitHead":"950e01998bbe5cbfffdc90147b1a534111d4a927","private":false,"release":{"branches":["main","next"]},"scripts":{"lint":"biome check .","test":"vitest run","build":"tsc -p tsconfig.build.json","format":"biome format --write .","prepack":"yarn build","lint:fix":"biome check --write .","typecheck":"tsc --noEmit","test:watch":"vitest"},"_npmUser":{"name":"jckcthbrt","email":"jckcthbrt@gmail.com"},"repository":{"url":"git+https://github.com/bueno-analytics/next-actuator.git","type":"git"},"_npmVersion":"11.6.2","description":"Provide Next.js routes for monitoring and management of your application in Production.","directories":{},"_nodeVersion":"24.11.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"next":"^15.0.3","husky":"^9.1.7","react":"^19.0.0","vitest":"^2.1.8","react-dom":"^19.0.0","@vitest/ui":"^2.1.8","typescript":"^4.8.3","@types/node":"^22.10.1","@types/react":"^19.0.1","@biomejs/biome":"^1.9.4","@commitlint/cli":"^20.1.0","semantic-release":"^25.0.2","next-test-api-route-handler":"^4.0.10","@commitlint/config-conventional":"^20.0.0"},"peerDependencies":{"next":"^12 || ^13 || ^14 || ^15"},"_npmOperationalInternal":{"tmp":"tmp/next-actuator_0.0.0-semantic-release_1763425519949_0.15365833321206468","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"@bueno-analytics/next-actuator","version":"2.0.0","description":"Provide Next.js routes for monitoring and management of your application in Production.","main":"dist/index.js","module":"dist/index.js","types":"dist/index.d.ts","author":{"name":"Jack Cuthbert","email":"jckcthbrt@gmail.com"},"license":"MIT","private":false,"scripts":{"build":"tsc -p tsconfig.build.json","prepack":"yarn build","typecheck":"tsc --noEmit","lint":"biome check .","lint:fix":"biome check --write .","format":"biome format --write .","test":"vitest run","test:watch":"vitest"},"engines":{"node":">=16.0.0"},"keywords":["actuator","next.js","health-check","ping","metrics","kubernetes"],"bugs":{"url":"https://github.com/bueno-analytics/next-actuator/issues"},"repository":{"type":"git","url":"git+https://github.com/bueno-analytics/next-actuator.git"},"release":{"branches":["main","next"]},"publishConfig":{"access":"public"},"homepage":"https://github.com/bueno-analytics/next-actuator#readme","devDependencies":{"@biomejs/biome":"^1.9.4","@commitlint/cli":"^20.1.0","@commitlint/config-conventional":"^20.0.0","@types/node":"^22.10.1","@types/react":"^19.0.1","@vitest/ui":"^2.1.8","husky":"^9.1.7","next":"^15.0.3","next-test-api-route-handler":"^4.0.10","react":"^19.0.0","react-dom":"^19.0.0","semantic-release":"^25.0.2","typescript":"^4.8.3","vitest":"^2.1.8"},"peerDependencies":{"next":"^12 || ^13 || ^14 || ^15"},"gitHead":"3973f0b391fbac6e43acac50a399d15afc4011c5","_id":"@bueno-analytics/next-actuator@2.0.0","_nodeVersion":"24.11.1","_npmVersion":"11.6.2","dist":{"integrity":"sha512-39ud+Fg7QS6/2Eb4MndUyvJ7iI2qg205QDxeSwqOAqfLOIMI0RHvyNcgBXawGYCKoFIwWkrtMw/S6ST46FITtA==","shasum":"c05c78c912007860bf0215412be9523729575f70","tarball":"https://registry.npmjs.org/@bueno-analytics/next-actuator/-/next-actuator-2.0.0.tgz","fileCount":7,"unpackedSize":7788,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFkygELRYrETXR+QFCmHM+T2/oBN1COVaOo94r97icDmAiByATNGag/LYQS4znxCriXi1EWMaxhVjp8uU8qZJsvLmg=="}]},"_npmUser":{"name":"jckcthbrt","email":"jckcthbrt@gmail.com"},"directories":{},"maintainers":[{"name":"jckcthbrt","email":"jckcthbrt@gmail.com"},{"name":"bencook","email":"benpetercook@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/next-actuator_2.0.0_1763426069925_0.7294397426907271"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-18T00:25:19.874Z","modified":"2025-11-18T00:34:30.320Z","0.0.0-semantic-release":"2025-11-18T00:25:20.203Z","2.0.0":"2025-11-18T00:34:30.119Z"},"bugs":{"url":"https://github.com/bueno-analytics/next-actuator/issues"},"author":{"name":"Jack Cuthbert","email":"jckcthbrt@gmail.com"},"license":"MIT","homepage":"https://github.com/bueno-analytics/next-actuator#readme","keywords":["actuator","next.js","health-check","ping","metrics","kubernetes"],"repository":{"type":"git","url":"git+https://github.com/bueno-analytics/next-actuator.git"},"description":"Provide Next.js routes for monitoring and management of your application in Production.","maintainers":[{"name":"jckcthbrt","email":"jckcthbrt@gmail.com"},{"name":"bencook","email":"benpetercook@gmail.com"}],"readme":"# next-actuator\n\n[![Npm package version](https://img.shields.io/npm/v/@bueno-analytics/next-actuator)](https://www.npmjs.com/package/@bueno-analytics/next-actuator) [![Release workflow](https://img.shields.io/github/workflow/status/bueno-analytics/next-actuator/Build/main)](https://github.com/bueno-analytics/next-actuator/actions/workflows/release.yml)\n\nProvide Next.js routes for monitoring and management of your application in Production.\n\nInspired by [rcruzper / express-actuator](https://github.com/rcruzper/express-actuator) but tailored for Next.js applications.\n\n## Endpoints\n\n| ID      | Description                                            |\n| ------- | ------------------------------------------------------ |\n| info    | Displays application information.                      |\n| metrics | Shows metrics information for the current application. |\n| health  | Shows application health information.                  |\n\n## Installation\n\n```shell\nnpm install --save @bueno-analytics/next-actuator\n# or\nyarn add @bueno-analytics/next-actuator\n```\n\n💡 TypeScript types are included\n\n## Usage\n\nCreate a file at `./pages/api/actuator/[...actuator].ts` (or similar) and\nreturn a call to `nextActuator()`. Named or default exports are available.\n\n```ts\n// ./pages/api/actuator/[...actuator].ts\nimport { nextActuator } from '@bueno-analytics/next-actuator'\n\n// Export the handler function with some options\nexport default nextActuator()\n```\n\n## Configuration\n\n```ts\nnextActuator({\n  enableHealth: true, // enable/disable /health endpoint (default true)\n  enableMetrics: true, // enable/disable /metrics endpoint (default true)\n  enableInfo: true, // enable/disable /info endpoint (default true)\n  healthEndpoint: '/health', // change the /health endpoint to something else\n  metricsEndpoint: '/metrics', // change the /metrics endpoint to something else\n  infoEndpoint: '/info' // change the /info endpoint to something else\n})\n```\n\n## Endpoints examples\n\n`GET http://localhost:3000/api/actuator/health`\n\n```json\n{\n  \"status\": \"UP\"\n}\n```\n\n`GET http://localhost:3000/api/actuator/info`\n\n```json\n{\n  \"build\": {\n    \"name\": \"My Cool Project\",\n    \"description\": \"Description from package.json\",\n    \"version\": \"1.2.3\"\n  }\n}\n```\n\n`GET http://localhost:3000/api/actuator/metrics`\n\n```json\n{\n  \"mem\": {\n    \"rss\": 550682624,\n    \"heapTotal\": 244232192,\n    \"heapUsed\": 213942064,\n    \"external\": 191258086,\n    \"arrayBuffers\": 188265357\n  },\n  \"uptime\": 2642.679833583\n}\n```\n","readmeFilename":"README.md"}