Releases · graphql-hive/envelop

#2742
62a8915
Thanks @enisdenjo! - Introduce new option onDocument

It's a callback that is invoked when the document is assembled by the visitor.

@envelop/[email protected]

Patch Changes

#2742
62a8915
Thanks @enisdenjo! - Remove empty and unused nodes from redacted
query after validation
Updated dependencies
[62a8915]:
- @envelop/[email protected]

Assets 2

06 Oct 10:20

github-actions

release-1759746055874

4c46755

October 06, 2025

@envelop/[email protected]

Minor Changes

#2715
262e761
Thanks @thomasleduc! - Support Sentry v9 and v10

@envelop/[email protected]

Patch Changes

#2610
398a137
Thanks @renovate! - dependencies updates:
- Updated dependency hot-shots@^11.0.0 ↗︎
  (from ^10.0.0, in peerDependencies)

Assets 2

19 Sep 08:21

github-actions

release-1758270108600

2b6b5d7

September 19, 2025

@envelop/[email protected]

Patch Changes

#2690
8f709a7
Thanks @Tolsee! - Fix rate limiting being wrongly applied to all
fields with a default configuration.

@envelop/[email protected]

Minor Changes

#2258
35539a7
Thanks @EmrysMyrddin! - Deprecate ttlPerType in favor of
ttlPerSchemaCoordinate, for a more streamlined API

Migration instructions

If you where using ttlPerType, you can merge the object into the ttlPerSchemaCoordinate, the
syntax doesn't change.
```
useResponseCache({
  session: null,
- ttlPerType: {
-   User: 10_000,
-   Profile: 600_000,
- },
  ttlPerSchemaCoordinate: {
    'Query.me': 0
+    User: 10_000,
+    Profile: 600_000,
  }
})
```

@envelop/[email protected]

Patch Changes

Updated dependencies
[35539a7]:
- @envelop/[email protected]

Assets 2

18 Sep 12:20

github-actions

release-1758198009664

5d852c2

September 18, 2025

@envelop/[email protected]

Patch Changes

#2665
92948d8
Thanks @EmrysMyrddin! - Fix getters and setters being stripped
away. The value was copied at plugin creation instead of copying the getter and setter (if any).

@envelop/[email protected]

Patch Changes

#2262
2525301
Thanks @renovate! - dependencies updates:
- Updated dependency lru-cache@^11.0.0 ↗︎
  (from ^10.0.0, in dependencies)
Updated dependencies
[92948d8]:
- @envelop/[email protected]

@envelop/[email protected]

Minor Changes

#2676
6164637
Thanks @EmrysMyrddin! - Validate the configuration at schema
loading time. The plugin now throws an error on invalid configuration, such as:
- Multiple field configuration matching the same field
- A field configuration matching a field already having a directive

Patch Changes

#2676
6164637
Thanks @EmrysMyrddin! - dependencies updates:
- Added dependency
  @types/picomatch@^4.0.2 ↗︎ (to
  dependencies)
- Added dependency picomatch@^4.0.3 ↗︎ (to
  dependencies)
- Removed dependency minimatch@^10.0.1 ↗︎
  (from dependencies)
#2676
6164637
Thanks @EmrysMyrddin! - Massive reduction of performance impact
on GraphQL execution. Overhead has been minimalized on rate-limited fields, and entirely
suppressed on other fields.
#2676
6164637
Thanks @EmrysMyrddin! - Fixed rateLimitDirectiveName option
being ignored.
Updated dependencies
[92948d8]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

#2262
2525301
Thanks @renovate! - dependencies updates:
- Updated dependency lru-cache@^11.0.0 ↗︎
  (from ^10.0.0, in dependencies)
Updated dependencies
[92948d8]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

#2262
2525301
Thanks @renovate! - dependencies updates:
- Updated dependency lru-cache@^11.0.0 ↗︎
  (from ^10.0.0, in dependencies)
Updated dependencies
[92948d8]:
- @envelop/[email protected]

Assets 2

05 Sep 02:09

github-actions

release-1757038166702

f1fbe8c

September 05, 2025

@envelop/[email protected]

Patch Changes

#2611
8dd5bda
Thanks @EmrysMyrddin! - Add a withState override to ease the
typing of plugins whith the same state for all scopes.

@envelop/[email protected]

Patch Changes

#2611
8dd5bda
Thanks @EmrysMyrddin! - Add a withState override to ease the
typing of plugins whith the same state for all scopes.
Updated dependencies
[8dd5bda]:
- @envelop/[email protected]

Assets 2

20 Jun 19:03

github-actions

release-1750446183466

9f0d6ff

June 20, 2025

@envelop/[email protected]

Minor Changes

#2607
3ebaa3b
Thanks @EmrysMyrddin! - Added new withState plugin utility
for easy data sharing between hooks.

New plugin utility to ease data sharing between hooks

Sometimes, plugins can grow in complexity and need to share data between its hooks.

A way to solve this can be to mutate the graphql context, but this context is not always available
in all hooks in Yoga or Hive Gateway plugins. Moreover, mutating the context gives access to your
internal data to all other plugins and graphql resolvers, without mentioning performance impact on
field access on this object.

The recommended approach to this problem was to use a WeakMap with a stable key (often the
context or request object). While it works, it's not very convenient for plugin developers,
and is prone to error with the choice of key.

The new withState utility solves this DX issue by providing an easy and straightforward API for
data sharing between hooks.
```
import { withState } from '@envelop/core'

type State = { foo: string }

const myPlugin = () =>
  withState<Plugin, State>(() => ({
    onParse({ state }) {
      state.forOperation.foo = 'foo'
    },
    onValidate({ state }) {
      const { foo } = state.forOperation
      console.log('foo', foo)
    }
  }))
```
The state payload field will be available in all relevant hooks, making it easy to access shared
data. It also forces the developer to choose the scope for the data:
- forOperation for a data scoped to GraphQL operation (Envelop, Yoga and Hive Gateway)
- forRequest for a data scoped to HTTP request (Yoga and Hive Gateway)
- forSubgraphExecution for a data scoped to the subgraph execution (Hive Gateway)
Not all scopes are available in all hooks, the type reflects which scopes are available

Under the hood, those states are kept in memory using WeakMap, which avoid any memory leaks.

It is also possible to manually retrieve the state with the getState function:
```
const myPlugin = () =>
  withState(getState => ({
    onParse({ context }) {
      // You can provide a payload, which will dictate which scope you have access to.
      // The scope can contain `context`, `request` and `executionRequest` fields.
      const state = getState({ context })
      // Use the state elsewhere.
    }
  }))
```