{"_id":"@dmamontov/graphql-mesh-health-checks-plugin","_rev":"1-54645eb3f172c3b28f7486d8f6728b80","name":"@dmamontov/graphql-mesh-health-checks-plugin","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@dmamontov/graphql-mesh-health-checks-plugin","version":"1.0.0","author":{"name":"Dmitry Mamontov"},"type":"module","repository":{"type":"git","url":"git+https://github.com/dmamontov/graphql-mesh-health-checks-plugin.git"},"license":"MIT","engines":{"node":">=20.0.0"},"main":"dist/cjs/index.js","module":"dist/esm/index.js","exports":{".":{"require":{"types":"./dist/typings/index.d.cts","default":"./dist/cjs/index.js"},"import":{"types":"./dist/typings/index.d.ts","default":"./dist/esm/index.js"},"default":{"types":"./dist/typings/index.d.ts","default":"./dist/esm/index.js"}},"./package.json":"./package.json"},"typings":"dist/typings/index.d.ts","scripts":{"build":"bob build","lint":"eslint ."},"peerDependencies":{"graphql":"*"},"dependencies":{"@envelop/core":"^5.0.0","@graphql-mesh/string-interpolation":"^0.5.3","@graphql-mesh/types":"^0.97.5","graphql":"*","graphql-yoga":"^5.1.1"},"devDependencies":{"@babel/core":"7.24.5","@eslint/js":"8.57.0","@theguild/prettier-config":"2.0.6","@types/node":"20.12.2","@typescript-eslint/eslint-plugin":"7.4.0","@typescript-eslint/parser":"7.4.0","bob-the-bundler":"7.0.1","eslint":"8.57.0","eslint-config-love":"43.1.0","eslint-config-prettier":"9.1.0","eslint-config-standard":"17.1.0","eslint-formatter-stylish":"8.40.0","eslint-import-resolver-alias":"1.1.2","eslint-import-resolver-typescript":"3.6.1","eslint-plugin-import":"2.29.1","eslint-plugin-jsonc":"2.14.1","eslint-plugin-n":"16.6.2","eslint-plugin-prettier":"5.1.3","eslint-plugin-promise":"6.1.1","eslint-plugin-sonar":"0.13.2","eslint-plugin-standard":"5.0.0","eslint-plugin-unicorn":"51.0.1","prettier":"3.2.5","ts-node":"10.9.2","typescript":"5.4.3"},"publishConfig":{"access":"public","directory":"dist"},"sideEffects":false,"typescript":{"definition":"dist/typings/index.d.ts"},"_id":"@dmamontov/graphql-mesh-health-checks-plugin@1.0.0","gitHead":"b2dc63decc3d11a1e1c0c07b3be57db24aa8ca02","description":"Health Checks Plugin is a plugin for GraphQL Mesh that introduces new routes specifically designed for monitoring and providing health information about your GraphQL service. This plugin adds three key endpoints: /version, /alive, and /ready, which can be","bugs":{"url":"https://github.com/dmamontov/graphql-mesh-health-checks-plugin/issues"},"homepage":"https://github.com/dmamontov/graphql-mesh-health-checks-plugin#readme","_nodeVersion":"20.5.1","_npmVersion":"9.8.0","dist":{"integrity":"sha512-RnjBvloHIVomY87ywxMXfW+RuvO4U309uHBBMkzjoGWdI1gvYaIPbFigacpqPKsiEcesBqWGJg1Uhvx0/SubQA==","shasum":"b20f00531f2a41acffa353aa2b1fbc86243d4f22","tarball":"https://registry.npmjs.org/@dmamontov/graphql-mesh-health-checks-plugin/-/graphql-mesh-health-checks-plugin-1.0.0.tgz","fileCount":25,"unpackedSize":23798,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD9p2XEfJBvxlPwzHuOBUkgJq/G2uO0jM9vZ9HC0UI5/gIgEhIYnQXnhf3LVoY5quzC2dQhpx8152qi+I5b7CVW8OY="}]},"_npmUser":{"name":"dmamontov","email":"d.slonyara@gmail.com"},"directories":{},"maintainers":[{"name":"dmamontov","email":"d.slonyara@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphql-mesh-health-checks-plugin_1.0.0_1715176025859_0.25231245869256"},"_hasShrinkwrap":false},"1.0.1":{"name":"@dmamontov/graphql-mesh-health-checks-plugin","version":"1.0.1","sideEffects":false,"peerDependencies":{"graphql":"*"},"dependencies":{"@envelop/core":"^5.0.0","@graphql-mesh/string-interpolation":"^0.5.3","@graphql-mesh/types":"^0.97.5","graphql":"*","graphql-yoga":"^5.1.1"},"repository":{"type":"git","url":"git+https://github.com/dmamontov/graphql-mesh-health-checks-plugin.git"},"author":{"name":"Dmitry Mamontov"},"license":"MIT","engines":{"node":">=20.0.0"},"main":"cjs/index.js","module":"esm/index.js","typings":"typings/index.d.ts","typescript":{"definition":"typings/index.d.ts"},"type":"module","exports":{".":{"require":{"types":"./typings/index.d.cts","default":"./cjs/index.js"},"import":{"types":"./typings/index.d.ts","default":"./esm/index.js"},"default":{"types":"./typings/index.d.ts","default":"./esm/index.js"}},"./package.json":"./package.json"},"_id":"@dmamontov/graphql-mesh-health-checks-plugin@1.0.1","gitHead":"458def93a99087bfd2bb7d083a2493aa150c653e","description":"Health Checks Plugin is a plugin for GraphQL Mesh that introduces new routes specifically designed for monitoring and providing health information about your GraphQL service. This plugin adds three key endpoints: /version, /alive, and /ready, which can be","bugs":{"url":"https://github.com/dmamontov/graphql-mesh-health-checks-plugin/issues"},"homepage":"https://github.com/dmamontov/graphql-mesh-health-checks-plugin#readme","_nodeVersion":"20.5.1","_npmVersion":"9.8.0","dist":{"integrity":"sha512-O12g9rlyV6S52Jhef1QEqiW8ba9kSxYlhaDaOXdstET5kCVIQw2boMrI0oPYwnNucNCmXXS+ljq8nTyuDElGwA==","shasum":"87c106255884396dabcee7e5e8f74c1d4a4b448d","tarball":"https://registry.npmjs.org/@dmamontov/graphql-mesh-health-checks-plugin/-/graphql-mesh-health-checks-plugin-1.0.1.tgz","fileCount":15,"unpackedSize":9398,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDgaTAJBoQPC85Whupo1sLFlRCosXgYKzJhgOpcS9p1QAIgD2NQ1XsHUX5RDPQaxJxvsHZOFKML6Qu4uweixcVOhU4="}]},"_npmUser":{"name":"dmamontov","email":"d.slonyara@gmail.com"},"directories":{},"maintainers":[{"name":"dmamontov","email":"d.slonyara@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphql-mesh-health-checks-plugin_1.0.1_1715176113599_0.8349845314132698"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-08T13:47:05.758Z","1.0.0":"2024-05-08T13:47:06.009Z","modified":"2024-05-08T13:48:33.916Z","1.0.1":"2024-05-08T13:48:33.746Z"},"maintainers":[{"name":"dmamontov","email":"d.slonyara@gmail.com"}],"description":"Health Checks Plugin is a plugin for GraphQL Mesh that introduces new routes specifically designed for monitoring and providing health information about your GraphQL service. This plugin adds three key endpoints: /version, /alive, and /ready, which can be","homepage":"https://github.com/dmamontov/graphql-mesh-health-checks-plugin#readme","repository":{"type":"git","url":"git+https://github.com/dmamontov/graphql-mesh-health-checks-plugin.git"},"author":{"name":"Dmitry Mamontov"},"bugs":{"url":"https://github.com/dmamontov/graphql-mesh-health-checks-plugin/issues"},"license":"MIT","readme":"# Health Checks Plugin for GraphQL Mesh\n\nHealth Checks Plugin is a plugin for GraphQL Mesh that introduces new routes specifically designed for monitoring and providing health information about your GraphQL service. This plugin adds three key endpoints: /version, /alive, and /ready, which can be configured to suit your operational and deployment needs.\n\n## Installation\n\nBefore you can use the Health Checks Plugin, you need to install it along with GraphQL Mesh if you haven't already done so. You can install these using npm or yarn.\n\n```bash\nnpm install @dmamontov/graphql-mesh-health-checks-plugin\n```\n\nor\n\n```bash\nyarn add @dmamontov/graphql-mesh-health-checks-plugin\n```\n\n## Configuration\n\n### Modifying tsconfig.json\n\nTo make TypeScript recognize the Health Checks Plugin, you need to add an alias in your tsconfig.json.\n\nAdd the following paths configuration under the compilerOptions in your tsconfig.json file:\n\n```json\n{\n  \"compilerOptions\": {\n    \"paths\": {\n       \"health-checks\": [\"node_modules/@dmamontov/graphql-mesh-health-checks-plugin\"]\n    }\n  }\n}\n```\n\n### Adding the Plugin to GraphQL Mesh\n\nYou need to include the Health Checks Plugin in your GraphQL Mesh configuration file (usually .meshrc.yaml). Below is an example configuration that demonstrates how to use this plugin:\n\n```yaml\nplugins:\n  - healthChecks:\n      alive:\n        endpoint: /alive\n      ready:\n        endpoint: /ready\n      version:\n        endpoint: /version\n        version: release-9fa5d011\n        git:\n          branch: main\n          shortHash: 9fa5d011\n          tag: 1.0.0\n        build:\n          date: 2024-05-02T08:10:44Z\n          number: 6762592306\n```\n\n## Conclusion\n\nRemember, always test your configurations in a development environment before applying them in production to ensure that everything works as expected.","readmeFilename":"README.md"}