Skip to content

Commit ae1be29

Browse files
Version Packages (#8155)
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @apollo/[email protected] ### Minor Changes - [#8148](#8148) [`80a1a1a`](80a1a1a) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Apollo Server now supports the incremental delivery protocol (`@defer` and `@stream`) that ships with `[email protected]`. To use the current protocol, clients must send the `Accept` header with a value of `multipart/mixed; incrementalSpec=v0.2`. Upgrading to 5.1 will depend on what version of `graphql` you have installed and whether you already support the incremental delivery protocol. ## I use `graphql@16` without incremental delivery Continue using `graphql` v16 with no additional changes. Incremental delivery won't be available. ## I use `graphql@16` but would like to add support for incremental delivery Install `[email protected]` and follow the ["Incremental delivery" guide](https://www.apollographql.com/docs/apollo-server/workflow/requests#incremental-delivery-experimental) to add the `@defer` and `@stream` directives to your schema. Clients should send the `Accept` header with a value of `multipart/mixed; incrementalSpec=v0.2` to get multipart responses. ## I use `[email protected]` and use incremental delivery You must upgrade to `[email protected]` to continue using incremental delivery. If you'd like to continue providing support for the legacy incremental protocol, install the [`@yaacovcr/transform`](https://github.com/yaacovCR/transform) package. Apollo Server will attempt to load this module when the client specifies an `Accept` header with a value of `multipart/mixed; deferSpec=20220824`. If this package is not installed, an error is returned by the server. Because Apollo Server now supports multiple versions of the incremental delivery types, the existing incremental delivery types have been renamed with an `Alpha2` suffix. If you import these types in your code, you will need to add the `Alpha2` suffix. ```diff import type { - GraphQLExperimentalFormattedInitialIncrementalExecutionResult, + GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha2, - GraphQLExperimentalFormattedSubsequentIncrementalExecutionResult, + GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha2, - GraphQLExperimentalFormattedIncrementalResult, + GraphQLExperimentalFormattedIncrementalResultAlpha2, - GraphQLExperimentalFormattedIncrementalDeferResult, + GraphQLExperimentalFormattedIncrementalDeferResultAlpha2, - GraphQLExperimentalFormattedIncrementalStreamResult, + GraphQLExperimentalFormattedIncrementalStreamResultAlpha2, } from '@apollo/server'; ``` Incremental delivery types for the `[email protected]` version are now available using the `Alpha9` suffix: ```ts import type { GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha9, GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha9, GraphQLExperimentalFormattedIncrementalResultAlpha9, GraphQLExperimentalFormattedIncrementalDeferResultAlpha9, GraphQLExperimentalFormattedIncrementalStreamResultAlpha9, GraphQLExperimentalFormattedCompletedResultAlpha9, GraphQLExperimentalPendingResultAlpha9, } from '@apollo/server'; ``` ## @apollo/[email protected] ### Patch Changes - Updated dependencies \[[`80a1a1a`](80a1a1a)]: - @apollo/[email protected] --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Jerel Miller <[email protected]>
1 parent 3c3bb8a commit ae1be29

File tree

9 files changed

+72
-86
lines changed

9 files changed

+72
-86
lines changed

.changeset/fruity-ways-tell.md

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

.changeset/pre.json

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

package-lock.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/integration-testsuite/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# @apollo/server-integration-testsuite
22

3+
## 5.1.0
4+
5+
### Patch Changes
6+
7+
- Updated dependencies [[`80a1a1a`](https://github.com/apollographql/apollo-server/commit/80a1a1af12b326d8c0f900bd85a25e14ee9cd9c0)]:
8+
- @apollo/server@5.1.0
9+
310
## 5.1.0-rc.0
411

512
### Patch Changes

packages/integration-testsuite/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@apollo/server-integration-testsuite",
3-
"version": "5.1.0-rc.0",
3+
"version": "5.1.0",
44
"description": "Test suite for Apollo Server integrations",
55
"main": "dist/cjs/index.js",
66
"module": "dist/esm/index.js",
@@ -39,7 +39,7 @@
3939
"dependencies": {
4040
"@apollo/cache-control-types": "^1.0.3",
4141
"@apollo/client": "^3.6.9",
42-
"@apollo/server": "5.1.0-rc.0",
42+
"@apollo/server": "5.1.0",
4343
"@apollo/usage-reporting-protobuf": "^4.1.1",
4444
"@apollo/utils.createhash": "^3.0.0",
4545
"@apollo/utils.keyvaluecache": "^4.0.0",

packages/plugin-response-cache/CHANGELOG.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# @apollo/server-plugin-response-cache
22

3-
## 5.0.1-rc.0
4-
5-
### Patch Changes
6-
7-
- Updated dependencies [[`80a1a1a`](https://github.com/apollographql/apollo-server/commit/80a1a1af12b326d8c0f900bd85a25e14ee9cd9c0)]:
8-
- @apollo/server@5.1.0-rc.0
9-
103
## 5.0.0
114

125
### Major Changes

packages/plugin-response-cache/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@apollo/server-plugin-response-cache",
3-
"version": "5.0.1-rc.0",
3+
"version": "5.0.0",
44
"description": "Apollo Server full query response cache",
55
"type": "module",
66
"main": "dist/cjs/index.js",
@@ -36,7 +36,7 @@
3636
"@apollo/utils.keyvaluecache": "^4.0.0"
3737
},
3838
"peerDependencies": {
39-
"@apollo/server": "^5.0.0 || ^5.1.0-rc",
39+
"@apollo/server": "^5.0.0",
4040
"graphql": "^16.11.0"
4141
}
4242
}

packages/server/CHANGELOG.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,60 @@
11
# @apollo/server
22

3+
## 5.1.0
4+
5+
### Minor Changes
6+
7+
- [#8148](https://github.com/apollographql/apollo-server/pull/8148) [`80a1a1a`](https://github.com/apollographql/apollo-server/commit/80a1a1af12b326d8c0f900bd85a25e14ee9cd9c0) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Apollo Server now supports the incremental delivery protocol (`@defer` and `@stream`) that ships with `[email protected]`. To use the current protocol, clients must send the `Accept` header with a value of `multipart/mixed; incrementalSpec=v0.2`.
8+
9+
Upgrading to 5.1 will depend on what version of `graphql` you have installed and whether you already support the incremental delivery protocol.
10+
11+
## I use `graphql@16` without incremental delivery
12+
13+
Continue using `graphql` v16 with no additional changes. Incremental delivery won't be available.
14+
15+
## I use `graphql@16` but would like to add support for incremental delivery
16+
17+
Install `[email protected]` and follow the ["Incremental delivery" guide](https://www.apollographql.com/docs/apollo-server/workflow/requests#incremental-delivery-experimental) to add the `@defer` and `@stream` directives to your schema. Clients should send the `Accept` header with a value of `multipart/mixed; incrementalSpec=v0.2` to get multipart responses.
18+
19+
## I use `[email protected]` and use incremental delivery
20+
21+
You must upgrade to `[email protected]` to continue using incremental delivery. If you'd like to continue providing support for the legacy incremental protocol, install the [`@yaacovcr/transform`](https://github.com/yaacovCR/transform) package. Apollo Server will attempt to load this module when the client specifies an `Accept` header with a value of `multipart/mixed; deferSpec=20220824`. If this package is not installed, an error is returned by the server.
22+
23+
Because Apollo Server now supports multiple versions of the incremental delivery types, the existing incremental delivery types have been renamed with an `Alpha2` suffix. If you import these types in your code, you will need to add the `Alpha2` suffix.
24+
25+
```diff
26+
import type {
27+
- GraphQLExperimentalFormattedInitialIncrementalExecutionResult,
28+
+ GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha2,
29+
30+
- GraphQLExperimentalFormattedSubsequentIncrementalExecutionResult,
31+
+ GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha2,
32+
33+
- GraphQLExperimentalFormattedIncrementalResult,
34+
+ GraphQLExperimentalFormattedIncrementalResultAlpha2,
35+
36+
- GraphQLExperimentalFormattedIncrementalDeferResult,
37+
+ GraphQLExperimentalFormattedIncrementalDeferResultAlpha2,
38+
39+
- GraphQLExperimentalFormattedIncrementalStreamResult,
40+
+ GraphQLExperimentalFormattedIncrementalStreamResultAlpha2,
41+
} from '@apollo/server';
42+
```
43+
44+
Incremental delivery types for the `[email protected]` version are now available using the `Alpha9` suffix:
45+
46+
```ts
47+
import type {
48+
GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha9,
49+
GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha9,
50+
GraphQLExperimentalFormattedIncrementalResultAlpha9,
51+
GraphQLExperimentalFormattedIncrementalDeferResultAlpha9,
52+
GraphQLExperimentalFormattedIncrementalStreamResultAlpha9,
53+
GraphQLExperimentalFormattedCompletedResultAlpha9,
54+
GraphQLExperimentalPendingResultAlpha9,
55+
} from '@apollo/server';
56+
```
57+
358
## 5.1.0-rc.0
459

560
### Minor Changes

packages/server/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@apollo/server",
3-
"version": "5.1.0-rc.0",
3+
"version": "5.1.0",
44
"description": "Core engine for Apollo GraphQL server",
55
"type": "module",
66
"main": "dist/cjs/index.js",

0 commit comments

Comments
 (0)