@visulima/health-check 2.0.16 → 2.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/LICENSE.md +27 -0
  3. package/README.md +8 -8
  4. package/dist/index.cjs +1 -1
  5. package/package.json +24 -24
package/CHANGELOG.md CHANGED
@@ -1,3 +1,31 @@
1
+ ## @visulima/health-check [2.0.18](https://github.com/visulima/visulima/compare/@visulima/health-check@2.0.17...@visulima/health-check@2.0.18) (2024-12-12)
2
+
3
+ ### Bug Fixes
4
+
5
+ * added missing placeholder variables into LICENSE.md file ([cef32c6](https://github.com/visulima/visulima/commit/cef32c6eb19dc3215a835e848ef12223a8fa05e0))
6
+ * allow node v23 ([8ca929a](https://github.com/visulima/visulima/commit/8ca929af311ce8036cbbfde68b6db05381b860a5))
7
+ * allowed node 23, updated dev dependencies ([f99d34e](https://github.com/visulima/visulima/commit/f99d34e01f6b13be8586a1b5d37dc8b8df0a5817))
8
+ * updated packem to v1.8.2 ([23f869b](https://github.com/visulima/visulima/commit/23f869b4120856cc97e2bffa6d508e2ae30420ea))
9
+ * updated packem to v1.9.2 ([47bdc2d](https://github.com/visulima/visulima/commit/47bdc2dfaeca4e7014dbe7772eae2fdf8c8b35bb))
10
+
11
+ ### Styles
12
+
13
+ * cs fixes ([46d31e0](https://github.com/visulima/visulima/commit/46d31e082e1865262bf380859c14fabd28ff456d))
14
+
15
+ ### Miscellaneous Chores
16
+
17
+ * updated dev dependencies ([a916944](https://github.com/visulima/visulima/commit/a916944b888bb34c34b0c54328b38d29e4399857))
18
+
19
+ ## @visulima/health-check [2.0.17](https://github.com/visulima/visulima/compare/@visulima/health-check@2.0.16...@visulima/health-check@2.0.17) (2024-10-05)
20
+
21
+ ### Bug Fixes
22
+
23
+ * updated dev dependencies, updated packem to v1.0.7, fixed naming of some lint config files ([c071a9c](https://github.com/visulima/visulima/commit/c071a9c8e129014a962ff654a16f302ca18a5c67))
24
+
25
+ ### Miscellaneous Chores
26
+
27
+ * updated dev dependencies ([736c6ce](https://github.com/visulima/visulima/commit/736c6ce7270b3e525a8ea9f79646a2a3fde47d4e))
28
+
1
29
  ## @visulima/health-check [2.0.16](https://github.com/visulima/visulima/compare/@visulima/health-check@2.0.15...@visulima/health-check@2.0.16) (2024-09-24)
2
30
 
3
31
  ### Bug Fixes
package/LICENSE.md CHANGED
@@ -0,0 +1,27 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 visulima
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
23
+ <!-- DEPENDENCIES -->
24
+ <!-- /DEPENDENCIES -->
25
+
26
+ <!-- TYPE_DEPENDENCIES -->
27
+ <!-- /TYPE_DEPENDENCIES -->
package/README.md CHANGED
@@ -43,9 +43,9 @@ pnpm add @visulima/health-check
43
43
 
44
44
  Keeping the API health check endpoints generic allows to use them for multiple purposes. In this section, we will review of the everyday use cases of an API health check endpoint
45
45
 
46
- - Container orchestrators and API load balancers can use API health check endpoint to find out about the process status
47
- - Usage of memory, disk, and other server resources can be monitored via API health check endpoints
48
- - Health checks can test APIs dependencies, such as databases and external service endpoints, to confirm availability and normal functioning.
46
+ - Container orchestrators and API load balancers can use API health check endpoint to find out about the process status
47
+ - Usage of memory, disk, and other server resources can be monitored via API health check endpoints
48
+ - Health checks can test APIs dependencies, such as databases and external service endpoints, to confirm availability and normal functioning.
49
49
 
50
50
  ## Usage
51
51
 
@@ -63,11 +63,11 @@ export default healthCheckHandler(HealthCheckService); // returns a http handler
63
63
 
64
64
  There are at least three different types of API health check endpoints designed to serve specific purposes.
65
65
 
66
- - _The readiness endpoint_, often available via `/health/ready`, returns the readiness state to accept incoming requests from the gateway or the upstream proxy. Readiness signals that the app is running normally but isn’t ready to receive requests yet.
66
+ - _The readiness endpoint_, often available via `/health/ready`, returns the readiness state to accept incoming requests from the gateway or the upstream proxy. Readiness signals that the app is running normally but isn’t ready to receive requests yet.
67
67
 
68
- - _The liveness endpoint_, often available via `/health/live`, returns the liveness of a microservice. If the check does not return the expected response, it means that the process is unhealthy or dead and should be replaced as soon as possible.
68
+ - _The liveness endpoint_, often available via `/health/live`, returns the liveness of a microservice. If the check does not return the expected response, it means that the process is unhealthy or dead and should be replaced as soon as possible.
69
69
 
70
- - _The generic health check endpoint_, often available via `/health`, returns the status of the service and the dependencies.
70
+ - _The generic health check endpoint_, often available via `/health`, returns the status of the service and the dependencies.
71
71
 
72
72
  Consider the following example: an API that loads JSON-based data into memory to serve requests.
73
73
 
@@ -189,8 +189,8 @@ If you would like to help take a look at the [list of issues](https://github.com
189
189
 
190
190
  ## Credits
191
191
 
192
- - [Daniel Bannert](https://github.com/prisis)
193
- - [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
192
+ - [Daniel Bannert](https://github.com/prisis)
193
+ - [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
194
194
 
195
195
  ## License
196
196
 
package/dist/index.cjs CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./packem_shared/dnsCheck-CN6R59pd.cjs"),h=require("./packem_shared/httpCheck-DT6HrAPG.cjs"),t=require("./packem_shared/nodeEnvCheck-aT51eSWt.cjs"),r=require("./packem_shared/pingCheck-DIrh3Cwy.cjs"),c=require("./packem_shared/healthCheckHandler-BH0Fcvsh.cjs"),n=require("./packem_shared/healthReadyHandler-DjRXCune.cjs"),a=require("./packem_shared/HealthCheck-DQvQhFYY.cjs");exports.dnsCheck=e;exports.httpCheck=h;exports.nodeEnvCheck=t;exports.pingCheck=r;exports.healthCheckHandler=c;exports.healthReadyHandler=n;exports.HealthCheck=a;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./packem_shared/dnsCheck-CN6R59pd.cjs"),h=require("./packem_shared/httpCheck-DT6HrAPG.cjs"),r=require("./packem_shared/nodeEnvCheck-aT51eSWt.cjs"),t=require("./packem_shared/pingCheck-DIrh3Cwy.cjs"),c=require("./packem_shared/healthCheckHandler-BH0Fcvsh.cjs"),n=require("./packem_shared/healthReadyHandler-DjRXCune.cjs"),a=require("./packem_shared/HealthCheck-DQvQhFYY.cjs");exports.dnsCheck=e;exports.httpCheck=h;exports.nodeEnvCheck=r;exports.pingCheck=t;exports.healthCheckHandler=c;exports.healthReadyHandler=n;exports.HealthCheck=a;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@visulima/health-check",
3
- "version": "2.0.16",
3
+ "version": "2.0.18",
4
4
  "description": "A library built to provide support for defining service health for node services. It allows you to register async health checks for your dependencies and the service itself, provides a health endpoint that exposes their status, and health metrics.",
5
5
  "keywords": [
6
6
  "anolilab",
@@ -75,17 +75,17 @@
75
75
  "devDependencies": {
76
76
  "@anolilab/eslint-config": "^15.0.3",
77
77
  "@anolilab/prettier-config": "^5.0.14",
78
- "@anolilab/semantic-release-pnpm": "^1.1.3",
79
- "@anolilab/semantic-release-preset": "^9.0.0",
80
- "@arethetypeswrong/cli": "^0.16.4",
81
- "@arthurgeron/eslint-plugin-react-usememo": "^2.4.1",
82
- "@babel/core": "^7.25.2",
78
+ "@anolilab/semantic-release-pnpm": "^1.1.5",
79
+ "@anolilab/semantic-release-preset": "^9.0.2",
80
+ "@arethetypeswrong/cli": "^0.17.1",
81
+ "@arthurgeron/eslint-plugin-react-usememo": "^2.4.4",
82
+ "@babel/core": "^7.26.0",
83
83
  "@rushstack/eslint-plugin-security": "^0.8.3",
84
- "@testing-library/react": "^16.0.1",
84
+ "@testing-library/react": "^16.1.0",
85
85
  "@types/node": "18.19.15",
86
- "@visulima/packem": "1.0.1",
87
- "@vitest/coverage-v8": "^2.1.1",
88
- "@vitest/ui": "^2.1.1",
86
+ "@visulima/packem": "1.9.2",
87
+ "@vitest/coverage-v8": "^2.1.8",
88
+ "@vitest/ui": "^2.1.8",
89
89
  "conventional-changelog-conventionalcommits": "8.0.0",
90
90
  "cross-env": "^7.0.3",
91
91
  "cross-fetch": "^4.0.0",
@@ -94,31 +94,31 @@
94
94
  "eslint-plugin-deprecation": "^3.0.0",
95
95
  "eslint-plugin-etc": "^2.0.3",
96
96
  "eslint-plugin-import": "npm:eslint-plugin-i@^2.29.1",
97
- "eslint-plugin-jsx-a11y": "^6.10.0",
97
+ "eslint-plugin-jsx-a11y": "^6.10.2",
98
98
  "eslint-plugin-mdx": "^3.1.5",
99
- "eslint-plugin-react": "^7.36.1",
100
- "eslint-plugin-react-hooks": "^4.6.2",
99
+ "eslint-plugin-react": "^7.37.2",
100
+ "eslint-plugin-react-hooks": "^5.1.0",
101
101
  "eslint-plugin-ssr-friendly": "^1.3.0",
102
- "eslint-plugin-testing-library": "^6.3.0",
102
+ "eslint-plugin-testing-library": "^7.1.1",
103
103
  "eslint-plugin-validate-jsx-nesting": "^0.1.1",
104
104
  "eslint-plugin-vitest": "^0.4.1",
105
105
  "eslint-plugin-vitest-globals": "^1.5.0",
106
- "msw": "^2.4.9",
106
+ "msw": "^2.6.8",
107
107
  "next": "^14.2.4",
108
- "node-mocks-http": "^1.16.0",
109
- "prettier": "^3.3.3",
108
+ "node-mocks-http": "^1.16.2",
109
+ "prettier": "^3.4.2",
110
110
  "react": "^18.3.1",
111
111
  "react-dom": "^18.3.1",
112
112
  "rimraf": "5.0.9",
113
113
  "semantic-release": "24.0.0",
114
114
  "typescript": "5.4.5",
115
- "vitest": "^2.1.1"
115
+ "vitest": "^2.1.8"
116
116
  },
117
117
  "optionalDependencies": {
118
- "next": "^14.2.4"
118
+ "next": ">=14.0 || >=15.0"
119
119
  },
120
120
  "engines": {
121
- "node": ">=18.* <=22.*"
121
+ "node": ">=18.* <=23.*"
122
122
  },
123
123
  "os": [
124
124
  "darwin",
@@ -147,11 +147,11 @@
147
147
  "clean": "rimraf node_modules dist .eslintcache",
148
148
  "dev": "pnpm run build --watch",
149
149
  "lint:attw": "attw --pack",
150
- "lint:eslint": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.js",
151
- "lint:eslint:fix": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.js --fix",
150
+ "lint:eslint": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.cjs",
151
+ "lint:eslint:fix": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.cjs --fix",
152
152
  "lint:package-json": "publint --strict",
153
- "lint:prettier": "prettier --config=.prettierrc.js --check .",
154
- "lint:prettier:fix": "prettier --config=.prettierrc.js --write .",
153
+ "lint:prettier": "prettier --config=.prettierrc.cjs --check .",
154
+ "lint:prettier:fix": "prettier --config=.prettierrc.cjs --write .",
155
155
  "lint:types": "tsc --noEmit",
156
156
  "test": "vitest run",
157
157
  "test:coverage": "vitest run --coverage",