console/packages/libraries/envelop/CHANGELOG.md
TheGuildBot 36dd9d3bff
Upcoming Release Changes (#7470)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-01-12 11:52:17 +01:00

487 lines
15 KiB
Markdown

# @graphql-hive/envelop
## 0.40.2
### Patch Changes
- Updated dependencies
[[`60133a4`](https://github.com/graphql-hive/console/commit/60133a41a684a0c1b1a45d47cf3cd30cc804c19d)]:
- @graphql-hive/core@0.20.0
## 0.40.1
### Patch Changes
- Updated dependencies
[[`711f4e6`](https://github.com/graphql-hive/console/commit/711f4e6a25ea7806d871554f2949a9ff300a0dbf),
[`4f9f988`](https://github.com/graphql-hive/console/commit/4f9f988d62c54f6e7a6820eba1fa9913146dcf9e)]:
- @graphql-hive/core@0.19.0
## 0.40.0
### Minor Changes
- [#7346](https://github.com/graphql-hive/console/pull/7346)
[`f266368`](https://github.com/graphql-hive/console/commit/f26636891b8b7e00b9a7823e9d584cedd9dd0f2d)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Add support for providing a logger object via
`HivePluginOptions`.
It is possible to provide the following options:
- **'trace'**
- **'debug'**
- **'info'** default
- **'warn'**
- **'error'**
```ts
import { createHive } from '@graphql-hive/core'
const client = createHive({
logger: 'info'
})
```
In addition to that, it is also possible to provide a Hive Logger instance, that allows more
control over how you want to log and forward logs.
```ts
import { createHive } from '@graphql-hive/core'
import { Logger } from '@graphql-hive/logger'
const client = createHive({
logger: new Logger()
})
```
Head to our [Hive Logger documentation](https://the-guild.dev/graphql/hive/docs/logger) to learn
more.
***
**The `HivePluginOptions.debug` option is now deprecated.** Instead, please use the `logger`
option to control logging levels.
```diff
import { createHive } from '@graphql-hive/core'
const client = createHive({
- debug: process.env.DEBUG === "1",
+ logger: process.env.DEBUG === "1" ? "debug" : "info",
})
```
**Note**: If the `logger` property is provided, the `debug` option is ignored.
***
**The `HivePluginOptions.agent.logger` option is now deprecated.** Instead, please provide
`HivePluginOptions.logger`.
```diff
import { createHive } from '@graphql-hive/core'
const logger = new Logger()
const client = createHive({
agent: {
- logger,
},
+ logger,
})
```
**Note**: If both options are provided, the `agent` option is ignored.
### Patch Changes
- Updated dependencies
[[`f266368`](https://github.com/graphql-hive/console/commit/f26636891b8b7e00b9a7823e9d584cedd9dd0f2d),
[`f266368`](https://github.com/graphql-hive/console/commit/f26636891b8b7e00b9a7823e9d584cedd9dd0f2d),
[`f266368`](https://github.com/graphql-hive/console/commit/f26636891b8b7e00b9a7823e9d584cedd9dd0f2d)]:
- @graphql-hive/core@0.18.0
## 0.38.1
### Patch Changes
- Updated dependencies
[[`64c8368`](https://github.com/graphql-hive/console/commit/64c8368c4b94b4ad2178d341442f0a0ffb4013f1)]:
- @graphql-hive/core@0.15.1
## 0.38.0
### Minor Changes
- [#7280](https://github.com/graphql-hive/console/pull/7280)
[`2cc443c`](https://github.com/graphql-hive/console/commit/2cc443c160e11313c905424b63a7c1362121d8d8)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Support circuit breaking for usage reporting.
Circuit breaking is a fault-tolerance pattern that prevents a system from repeatedly calling a
failing service. When errors or timeouts exceed a set threshold, the circuit “opens,” blocking
further requests until the service recovers.
This ensures that during a network issue or outage, the service using the Hive SDK remains healthy
and is not overwhelmed by failed usage reports or repeated retries.
```ts
import { createClient } from '@graphql-hive/core'
const client = createClient({
agent: {
circuitBreaker: {
/**
* Count of requests before starting evaluating.
* Default: 5
*/
volumeThreshold: 5,
/**
* Percentage of requests failing before the circuit breaker kicks in.
* Default: 50
*/
errorThresholdPercentage: 1,
/**
* After what time the circuit breaker is attempting to retry sending requests in milliseconds
* Default: 30_000
*/
resetTimeout: 10_000
}
}
})
```
### Patch Changes
- Updated dependencies
[[`2cc443c`](https://github.com/graphql-hive/console/commit/2cc443c160e11313c905424b63a7c1362121d8d8)]:
- @graphql-hive/core@0.15.0
## 0.37.0
### Minor Changes
- [#7264](https://github.com/graphql-hive/console/pull/7264)
[`582bc0e`](https://github.com/graphql-hive/console/commit/582bc0e2a4a95d0023d1cdbe627bc6147f82af8e)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Introduce debug log level. HTTP retry log pollute
the error log. The retries are now logged to the debug level. In order to see debug logs set the
`debug` option to true.
```ts
const hive = createHive({
debug: true
})
```
If you are using a custom logger, make sure to provide a `debug` logging method implementation.
```ts
const hive = createHive({
debug: true,
agent: {
logger: {
info() {},
error() {},
debug() {}
}
}
})
```
### Patch Changes
- Updated dependencies
[[`582bc0e`](https://github.com/graphql-hive/console/commit/582bc0e2a4a95d0023d1cdbe627bc6147f82af8e)]:
- @graphql-hive/core@0.14.0
## 0.36.4
### Patch Changes
- [#7253](https://github.com/graphql-hive/console/pull/7253)
[`43920cd`](https://github.com/graphql-hive/console/commit/43920cdb3d56a54c66c61bbc6ca1cc6af4a7b5ee)
Thanks [@ardatan](https://github.com/ardatan)! - Send correct version of the client packages,
previously they were sending the version of `@graphql-hive/core` package.
- Updated dependencies
[[`43920cd`](https://github.com/graphql-hive/console/commit/43920cdb3d56a54c66c61bbc6ca1cc6af4a7b5ee),
[`43920cd`](https://github.com/graphql-hive/console/commit/43920cdb3d56a54c66c61bbc6ca1cc6af4a7b5ee)]:
- @graphql-hive/core@0.13.2
## 0.36.3
### Patch Changes
- [#7248](https://github.com/graphql-hive/console/pull/7248)
[`d8f6e25`](https://github.com/graphql-hive/console/commit/d8f6e252ee3cd22948eb0d64b9d25c9b04dba47c)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Support project and personal access tokens (`hvp1/`
and `hvu1/`).
- Updated dependencies
[[`d8f6e25`](https://github.com/graphql-hive/console/commit/d8f6e252ee3cd22948eb0d64b9d25c9b04dba47c)]:
- @graphql-hive/core@0.13.1
## 0.36.2
### Patch Changes
- Updated dependencies
[[`8d56b98`](https://github.com/graphql-hive/console/commit/8d56b9848028d65442cb1dada139f5a17d464f1b)]:
- @graphql-hive/core@0.13.0
## 0.36.1
### Patch Changes
- Updated dependencies
[[`bbd5643`](https://github.com/graphql-hive/console/commit/bbd5643924eb2b32511e96a03a3a5a978a66adee)]:
- @graphql-hive/core@0.12.0
## 0.36.0
### Minor Changes
- [#6637](https://github.com/graphql-hive/console/pull/6637)
[`5130fc1`](https://github.com/graphql-hive/console/commit/5130fc1db8c50ac0eb35d901623594749772c550)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Add error logging for invalid combinations of the
`target` and `token` configuration.
- Please make sure to provide the `target` option for usage reporting when using a token that
starts with `hvo1/`.
- Please make sure to **not** provide a `target` option for usage reporting when a token does
**not** start with `hvo1/`
### Patch Changes
- Updated dependencies
[[`5130fc1`](https://github.com/graphql-hive/console/commit/5130fc1db8c50ac0eb35d901623594749772c550)]:
- @graphql-hive/core@0.11.0
## 0.35.1
### Patch Changes
- Updated dependencies
[[`ee70018`](https://github.com/graphql-hive/console/commit/ee7001883970fac81210ec21ce70a72bfd3b67bb),
[`a003f78`](https://github.com/graphql-hive/console/commit/a003f781cb1a38d8b00a3256163c50e3893db5f2)]:
- @graphql-hive/core@0.10.1
## 0.35.0
### Minor Changes
- [#6574](https://github.com/graphql-hive/console/pull/6574)
[`494697e`](https://github.com/graphql-hive/console/commit/494697e20f67ef877cd5dd63ccd29984c719ab44)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Add support for providing a target for usage
reporting with organization access tokens. This can either be a slug following the format
`$organizationSlug/$projectSlug/$targetSlug` (e.g `the-guild/graphql-hive/staging`) or an UUID
(e.g. `a0f4c605-6541-4350-8cfe-b31f21a4bf80`)
```ts
import { useHive } from '@graphql-hive/envelop'
const hivePlugin = useHive({
enabled: true,
token: 'ORGANIZATION_ACCESS_TOKEN',
usage: {
target: 'my-org/my-project/my-target'
}
})
```
### Patch Changes
- Updated dependencies
[[`494697e`](https://github.com/graphql-hive/console/commit/494697e20f67ef877cd5dd63ccd29984c719ab44)]:
- @graphql-hive/core@0.10.0
## 0.34.1
### Patch Changes
- Updated dependencies
[[`ae2d16d`](https://github.com/graphql-hive/console/commit/ae2d16d553e264c813ac65d78eacab3d7a2efeae)]:
- @graphql-hive/core@0.9.1
## 0.34.0
### Minor Changes
- [#6488](https://github.com/graphql-hive/console/pull/6488)
[`f7d65fe`](https://github.com/graphql-hive/console/commit/f7d65feb5aaf4f4f86dfc0fe5df3ea4c3df1d7a8)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Include and log a `x-request-id` header for all
requests sent to the Hive API. This helps users to share more context with Hive staff when
encountering errors.
### Patch Changes
- Updated dependencies
[[`f7d65fe`](https://github.com/graphql-hive/console/commit/f7d65feb5aaf4f4f86dfc0fe5df3ea4c3df1d7a8)]:
- @graphql-hive/core@0.9.0
## 0.33.13
### Patch Changes
- [#6383](https://github.com/graphql-hive/console/pull/6383)
[`ec356a7`](https://github.com/graphql-hive/console/commit/ec356a7784d1f59722f80a69f501f1f250b2f6b2)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - Collect custom scalars from arguments
and input object fields
- Updated dependencies
[[`ec356a7`](https://github.com/graphql-hive/console/commit/ec356a7784d1f59722f80a69f501f1f250b2f6b2)]:
- @graphql-hive/core@0.8.4
## 0.33.12
### Patch Changes
- Updated dependencies
[[`039c66b`](https://github.com/graphql-hive/console/commit/039c66bd24d4339e56b4e1e1fc7f8fa68de7e954)]:
- @graphql-hive/core@0.8.3
## 0.33.11
### Patch Changes
- [#6057](https://github.com/graphql-hive/console/pull/6057)
[`e4f8b0a`](https://github.com/graphql-hive/console/commit/e4f8b0a51d1158da966a719f321bc13e5af39ea0)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - Explain what Hive is in README
## 0.33.10
### Patch Changes
- [#5676](https://github.com/graphql-hive/platform/pull/5676)
[`c728803`](https://github.com/graphql-hive/platform/commit/c7288038f24c0214b4023994f306c6229c1ce72c)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - Correct collection of enum values when
used in a list
- Updated dependencies
[[`c728803`](https://github.com/graphql-hive/platform/commit/c7288038f24c0214b4023994f306c6229c1ce72c)]:
- @graphql-hive/core@0.8.2
## 0.33.9
### Patch Changes
- [#5667](https://github.com/kamilkisiela/graphql-hive/pull/5667)
[`be5d39c`](https://github.com/kamilkisiela/graphql-hive/commit/be5d39cbf08d0681d142e83a708d300abc504c44)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - Report enum values when an enum is used
as an output type
- Updated dependencies
[[`be5d39c`](https://github.com/kamilkisiela/graphql-hive/commit/be5d39cbf08d0681d142e83a708d300abc504c44)]:
- @graphql-hive/core@0.8.1
## 0.33.8
### Patch Changes
- Updated dependencies
[[`3ffdb6e`](https://github.com/kamilkisiela/graphql-hive/commit/3ffdb6e9466deb3c3aa09eea1445fc4caf698fd5)]:
- @graphql-hive/core@0.8.0
## 0.33.7
### Patch Changes
- Updated dependencies
[[`a896642`](https://github.com/kamilkisiela/graphql-hive/commit/a896642197e6d7779ba7ed71f365dfbd80532282)]:
- @graphql-hive/core@0.7.1
## 0.33.6
### Patch Changes
- [#5361](https://github.com/kamilkisiela/graphql-hive/pull/5361)
[`3f03e7b`](https://github.com/kamilkisiela/graphql-hive/commit/3f03e7b3a65707ba8aa04335684f0aa8d261868f)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - Fixed issue where usage reports were
sent only on app disposal or max batch size, now also sent at set intervals.
- Updated dependencies
[[`3f03e7b`](https://github.com/kamilkisiela/graphql-hive/commit/3f03e7b3a65707ba8aa04335684f0aa8d261868f),
[`0a3b24d`](https://github.com/kamilkisiela/graphql-hive/commit/0a3b24d400770c2cc84642959febb9288ad1c1b7)]:
- @graphql-hive/core@0.7.0
## 0.33.5
### Patch Changes
- Updated dependencies
[[`f2fef08`](https://github.com/kamilkisiela/graphql-hive/commit/f2fef08e9d1e13cb4a89d3882922db6dc822542e)]:
- @graphql-hive/core@0.6.1
## 0.33.4
### Patch Changes
- Updated dependencies
[[`e6dc5c9`](https://github.com/kamilkisiela/graphql-hive/commit/e6dc5c9df34c30c52555b27b0bca50e0be75480b)]:
- @graphql-hive/core@0.6.0
## 0.33.3
### Patch Changes
- Updated dependencies
[[`f1e43c6`](https://github.com/kamilkisiela/graphql-hive/commit/f1e43c641f3ebac931839c7dfbdcb3a885167562)]:
- @graphql-hive/core@0.5.0
## 0.33.2
### Patch Changes
- Updated dependencies
[[`b8998e7`](https://github.com/kamilkisiela/graphql-hive/commit/b8998e7ead84a2714d13678aaf1e349e648eb90a)]:
- @graphql-hive/core@0.4.0
## 0.33.1
### Patch Changes
- [#4932](https://github.com/kamilkisiela/graphql-hive/pull/4932)
[`cbc8364`](https://github.com/kamilkisiela/graphql-hive/commit/cbc836488b4acfb618fd877005ecf0126f1706b6)
Thanks [@n1ru4l](https://github.com/n1ru4l)! - Prevent failing usage reporting when returning an
object with additional properties aside from `name` and `version` from the client info
object/factory function.
- Updated dependencies
[[`cbc8364`](https://github.com/kamilkisiela/graphql-hive/commit/cbc836488b4acfb618fd877005ecf0126f1706b6)]:
- @graphql-hive/core@0.3.1
## 0.33.0
### Minor Changes
- [#4573](https://github.com/kamilkisiela/graphql-hive/pull/4573)
[`06d465e`](https://github.com/kamilkisiela/graphql-hive/commit/06d465e882b569b6d0dbd5b271d2d98aafaec0b1)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - Break `@graphql-hive/client` into
library-specific packages:
- `@graphql-hive/core` - Core functionality
- `@graphql-hive/apollo` - Apollo Client integration
- `@graphql-hive/yoga` - Yoga Server integration
- `@graphql-hive/envelop` - Envelop integration
Migration steps are available in the README of each package.
- [#4494](https://github.com/kamilkisiela/graphql-hive/pull/4494)
[`c5eeac5`](https://github.com/kamilkisiela/graphql-hive/commit/c5eeac5ccef9e2dcc3c8bb33deec0fb95af9552e)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - 🚨 BREAKING CHANGE 🚨 Requires now Node
v16+
- [#4573](https://github.com/kamilkisiela/graphql-hive/pull/4573)
[`06d465e`](https://github.com/kamilkisiela/graphql-hive/commit/06d465e882b569b6d0dbd5b271d2d98aafaec0b1)
Thanks [@kamilkisiela](https://github.com/kamilkisiela)! - **Migration**
Migration steps are available in the README.
```diff
- import { useHive } from '@graphql-hive/client';
+ import { useHive } from '@graphql-hive/envelop';
```
### Patch Changes
- Updated dependencies
[[`06d465e`](https://github.com/kamilkisiela/graphql-hive/commit/06d465e882b569b6d0dbd5b271d2d98aafaec0b1),
[`c5eeac5`](https://github.com/kamilkisiela/graphql-hive/commit/c5eeac5ccef9e2dcc3c8bb33deec0fb95af9552e)]:
- @graphql-hive/core@0.3.0