Skip to content

Commit c7bca8a

Browse files
github-actions[bot]github-actions[bot]
authored
ci: release (#7252)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 2960fee commit c7bca8a

File tree

9 files changed

+137
-23
lines changed

9 files changed

+137
-23
lines changed

‎.changeset/metal-guests-melt.md‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎docs/content/3.middleware/3.api/middleware.api.json‎

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3566,8 +3566,8 @@
35663566
},
35673567
{
35683568
"kind": "Reference",
3569-
"text": "Express",
3570-
"canonicalReference": "@types/express!e.Express:interface"
3569+
"text": "Server",
3570+
"canonicalReference": "!\"\\\"http\\\"\".Server:class"
35713571
},
35723572
{
35733573
"kind": "Content",
@@ -3733,6 +3733,38 @@
37333733
"startIndex": 1,
37343734
"endIndex": 4
37353735
}
3736+
},
3737+
{
3738+
"kind": "PropertySignature",
3739+
"canonicalReference": "@vue-storefront/middleware!CreateServerOptions#readinessProbes:member",
3740+
"docComment": "/**\n * Array of functions that will be called in parallel every time the /readyz endpoint receives a GET request If at least one function throws an exception, the response from the /readyz endpoint will report an error\n *\n * @see\n *\n * https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes\n */\n",
3741+
"excerptTokens": [
3742+
{
3743+
"kind": "Content",
3744+
"text": "readinessProbes?: "
3745+
},
3746+
{
3747+
"kind": "Reference",
3748+
"text": "ReadinessProbe",
3749+
"canonicalReference": "@vue-storefront/middleware!ReadinessProbe:type"
3750+
},
3751+
{
3752+
"kind": "Content",
3753+
"text": "[]"
3754+
},
3755+
{
3756+
"kind": "Content",
3757+
"text": ";"
3758+
}
3759+
],
3760+
"isReadonly": false,
3761+
"isOptional": true,
3762+
"releaseTag": "Public",
3763+
"name": "readinessProbes",
3764+
"propertyTypeTokenRange": {
3765+
"startIndex": 1,
3766+
"endIndex": 3
3767+
}
37363768
}
37373769
],
37383770
"extendsTokenRanges": []
@@ -6204,6 +6236,41 @@
62046236
"endIndex": 6
62056237
}
62066238
},
6239+
{
6240+
"kind": "TypeAlias",
6241+
"canonicalReference": "@vue-storefront/middleware!ReadinessProbe:type",
6242+
"docComment": "/**\n * Function that will be called to determine readiness of middleware to accept connections\n *\n * @returns Return value is never considered - only thrown exceptions\n *\n * @throws\n *\n * The implementation *must* throw an exception at some point in the code, which means that the readiness check should fail\n */\n",
6243+
"excerptTokens": [
6244+
{
6245+
"kind": "Content",
6246+
"text": "export type ReadinessProbe = "
6247+
},
6248+
{
6249+
"kind": "Content",
6250+
"text": "() => "
6251+
},
6252+
{
6253+
"kind": "Reference",
6254+
"text": "Promise",
6255+
"canonicalReference": "!Promise:interface"
6256+
},
6257+
{
6258+
"kind": "Content",
6259+
"text": "<void>"
6260+
},
6261+
{
6262+
"kind": "Content",
6263+
"text": ";"
6264+
}
6265+
],
6266+
"fileUrlPath": "src/types/server.ts",
6267+
"releaseTag": "Public",
6268+
"name": "ReadinessProbe",
6269+
"typeTokenRange": {
6270+
"startIndex": 1,
6271+
"endIndex": 4
6272+
}
6273+
},
62076274
{
62086275
"kind": "TypeAlias",
62096276
"canonicalReference": "@vue-storefront/middleware!RecordOverloadedReturnType:type",

‎docs/content/3.middleware/4.reference/change-log.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Change log
22

3+
## 5.0.0
4+
5+
### Major Changes
6+
7+
- [CHANGED] [BREAKING] Changed return type of `createServer()` from `Express` to `Server` (from built-in `node:http` package). Both of those types' interfaces have the `.listen()` method with the same shape. In some older templates for starting the middleware (`middleware.js` in your repo) you come across:
8+
9+
```ts
10+
async function runMiddleware(app: Express) {
11+
```
12+
13+
If you're using that older template, please change the `Express` type to `Server`:
14+
15+
```diff
16+
+ import { Server } from "node:http"
17+
+ async function runMiddleware(app: Server) {
18+
- async function runMiddleware(app: Express) {
19+
```
20+
21+
- [ADDED] New GET /readyz endpoint for middleware for using with Kubernetes readiness probes. Please see https://docs.alokai.com/middleware/guides/readiness-probes for more information
22+
323
## 4.3.1
424
525
### Patch Changes

‎docs/content/3.middleware/4.reference/multistore/change-log.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Change log
22

3+
## 4.1.1
4+
5+
### Patch Changes
6+
7+
- Updated dependencies:
8+
- @vue-storefront/middleware@5.0.0
9+
310
## 4.1.0
411

512
### Minor Changes

‎packages/middleware/CHANGELOG.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Change log
22

3+
## 5.0.0
4+
5+
### Major Changes
6+
7+
- [CHANGED] [BREAKING] Changed return type of `createServer()` from `Express` to `Server` (from built-in `node:http` package). Both of those types' interfaces have the `.listen()` method with the same shape. In some older templates for starting the middleware (`middleware.js` in your repo) you come across:
8+
9+
```ts
10+
async function runMiddleware(app: Express) {
11+
```
12+
13+
If you're using that older template, please change the `Express` type to `Server`:
14+
15+
```diff
16+
+ import { Server } from "node:http"
17+
+ async function runMiddleware(app: Server) {
18+
- async function runMiddleware(app: Express) {
19+
```
20+
21+
- [ADDED] New GET /readyz endpoint for middleware for using with Kubernetes readiness probes. Please see https://docs.alokai.com/middleware/guides/readiness-probes for more information
22+
323
## 4.3.1
424
525
### Patch Changes

‎packages/middleware/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@vue-storefront/middleware",
3-
"version": "4.3.1",
3+
"version": "5.0.0",
44
"main": "lib/index.cjs.js",
55
"module": "lib/index.es.js",
66
"types": "lib/index.d.ts",

‎packages/multistore/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Change log
22

3+
## 4.1.1
4+
5+
### Patch Changes
6+
7+
- Updated dependencies:
8+
- @vue-storefront/middleware@5.0.0
9+
310
## 4.1.0
411

512
### Minor Changes

‎packages/multistore/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@vue-storefront/multistore",
3-
"version": "4.1.0",
3+
"version": "4.1.1",
44
"author": "Fifciu",
55
"license": "MIT",
66
"main": "lib/index.cjs.js",
@@ -20,7 +20,7 @@
2020
"prepublishOnly": "yarn build"
2121
},
2222
"dependencies": {
23-
"@vue-storefront/middleware": "^4.1.0",
23+
"@vue-storefront/middleware": "^5.0.0",
2424
"express": "^4.18.1"
2525
},
2626
"publishConfig": {

‎yarn.lock‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5023,6 +5023,17 @@
50235023
local-pkg "^0.5.0"
50245024
magic-string-ast "^0.5.0"
50255025

5026+
"@vue-storefront/middleware@^4.2.0":
5027+
version "4.3.1"
5028+
resolved "https://registry.yarnpkg.com/@vue-storefront/middleware/-/middleware-4.3.1.tgz#075a594f35b9a6cbe3969eb2f1a101eaa632e04f"
5029+
integrity sha512-hIFp6djLFt3SLkeC0bs0CAiLfSifJMxdZQXxdnd9wA6Ud4IltG0ykVwXgedMmU4UiuANruUMQczDo5LCbJ5hYA==
5030+
dependencies:
5031+
consola "^2.15.3"
5032+
cookie-parser "^1.4.6"
5033+
cors "^2.8.5"
5034+
express "^4.18.1"
5035+
helmet "^5.1.1"
5036+
50265037
"@vue-storefront/rollup-config@^0.0.6":
50275038
version "0.0.6"
50285039
resolved "https://registry.yarnpkg.com/@vue-storefront/rollup-config/-/rollup-config-0.0.6.tgz#625f4e67790f11e2b9ff2843a95fea52849effa2"

0 commit comments

Comments
 (0)