Skip to content

Add @graphiql/react devDep to doc-explorer and history plugins#4231

Merged
trevor-scheer merged 1 commit into
graphql:mainfrom
trevor-scheer:trevor/fix-monorepo-build-order
May 7, 2026
Merged

Add @graphiql/react devDep to doc-explorer and history plugins#4231
trevor-scheer merged 1 commit into
graphql:mainfrom
trevor-scheer:trevor/fix-monorepo-build-order

Conversation

@trevor-scheer

@trevor-scheer trevor-scheer commented May 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • @graphiql/plugin-doc-explorer and @graphiql/plugin-history import from @graphiql/react at build time but only declared it as a peer dep.
  • Yarn workspaces topologically orders builds via dependencies/devDependencies, not peerDependencies, so on a clean checkout these plugins built before @graphiql/react emitted its dist/*.d.ts. vite-plugin-dts then ran tsc against unresolved @graphiql/react imports and published .d.ts artifacts with degraded types — hooks like useDocExplorer and useDocExplorerActions resolve to () => any in @graphiql/plugin-doc-explorer@0.4.1 on npm.
  • Matches the pattern already used in @graphiql/plugin-explorer and @graphiql/plugin-code-exporter.

Impact on published types

Diff between @graphiql/plugin-doc-explorer@0.4.1 on npm (built without this fix) and dist/ produced after this change:

--- dist/context.d.ts (npm 0.4.1)
+++ dist/context.d.ts (after fix)
-export declare type DocExplorerFieldDef = ...
+export type DocExplorerFieldDef = ...

-export declare const useDocExplorer: () => any;
+export declare const useDocExplorer: () => DocExplorerNavStack;

-export declare const useDocExplorerActions: () => any;
+export declare const useDocExplorerActions: () => {
+    push(item: DocExplorerNavStackItem): void;
+    pop(): void;
+    reset(): void;
+    resolveSchemaReferenceToNavItem(schemaReference: SchemaReference | null): void;
+    rebuildNavStackWithSchema(schema: GraphQLSchema): void;
+};
--- dist/deprecated.d.ts (npm 0.4.1)
+++ dist/deprecated.d.ts (after fix)
-export declare function useExplorerContext(): any;
+export declare function useExplorerContext(): {
+    explorerNavStack: import('./context').DocExplorerNavStack;
+    push(item: import('./context').DocExplorerNavStackItem): void;
+    pop(): void;
+    reset(): void;
+    resolveSchemaReferenceToNavItem(schemaReference: import('@graphiql/react').SchemaReference | null): void;
+    rebuildNavStackWithSchema(schema: import('graphql').GraphQLSchema): void;
+};

Every other .d.ts file in the package also flips declare type X to type X — a tsc artifact of the resolution failure, not user-visible.

Changes

  • Add "@graphiql/react": "^0.37.0" to devDependencies in packages/graphiql-plugin-doc-explorer/package.json and packages/graphiql-plugin-history/package.json.
  • Lockfile + patch changeset for both packages.

Validation Steps

  1. Reproduce the published bug: 
    npm pack @graphiql/plugin-doc-explorer@0.4.1
tar xzf graphiql-plugin-doc-explorer-0.4.1.tgz
grep useDocExplorer package/dist/context.d.ts
# → useDocExplorer: () => any
  2. Confirm fix: check out this branch, run yarn build, then: 
    grep useDocExplorer packages/graphiql-plugin-doc-explorer/dist/context.d.ts
# → useDocExplorer: () => DocExplorerNavStack
  3. Build order: @graphiql/react should appear before both plugins in yarn build output.
  4. The Release workflow on this PR should no longer log TS2307: Cannot find module '@graphiql/react' (compare to run 25513011736 for the broken baseline).

@trevor-scheer
Declare @graphiql/react as a build-time dep of `plugin-doc-explorer…
8bbb815 
…` and `plugin-history`

Both packages import from `@graphiql/react` at build time but only declared it as
a peer dep. Yarn workspaces orders builds via `dependencies`/`devDependencies`,
not `peerDependencies`, so on a clean checkout these plugins built before
`@graphiql/react` emitted its `dist/*.d.ts`. `vite-plugin-dts` then ran `tsc`
against unresolved `@graphiql/react` imports and published `.d.ts` artifacts
where hooks like `useDocExplorer` and `useDocExplorerActions` resolved to
`() => any` instead of their real shapes.

Matches the existing pattern in `plugin-explorer` and `plugin-code-exporter`.
@changeset-bot

changeset-bot Bot commented May 7, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 8bbb815

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@graphiql/plugin-doc-explorer Patch
@graphiql/plugin-history Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@trevor-scheer trevor-scheer marked this pull request as ready for review May 7, 2026 19:09
@trevor-scheer trevor-scheer enabled auto-merge (squash) May 7, 2026 19:09
@trevor-scheer trevor-scheer merged commit 6f5d5d2 into graphql:main May 7, 2026
13 checks passed
@acao acao mentioned this pull request May 7, 2026
Closed
This was referenced May 8, 2026
Open
Open
@trevor-scheer trevor-scheer deleted the trevor/fix-monorepo-build-order branch May 8, 2026 02:51
This was referenced May 8, 2026
Closed
Closed
This was referenced May 9, 2026
Open
Merged
benjie pushed a commit that referenced this pull request May 11, 2026
@github-actions
Version Packages (#4247)
a589ca2 
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
## @graphiql/toolkit@0.12.0

### Minor Changes

- [#4199](#4199)
[`463df14`](463df14)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Send
spec-compliant `Accept` header (`application/graphql-response+json`) in
`createSimpleFetcher`

## codemirror-graphql@2.2.5

### Patch Changes

- Updated dependencies
\[[`914a547`](914a547),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1

## graphiql@5.2.3

### Patch Changes

- [#4181](#4181)
[`f1a210e`](f1a210e)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix schema
prop to skip introspection when IntrospectionQuery data is provided

Previously, passing an `IntrospectionQuery` result as the `schema` prop
would still trigger a network introspection request. The
`shouldIntrospect` check only recognized `GraphQLSchema` instances (via
`isSchema`), not raw introspection data. Now, when an
`IntrospectionQuery` is passed, a schema is built from it directly using
`buildClientSchema` and introspection is skipped.

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

- Updated dependencies
\[[`f1a210e`](f1a210e),
[`6f5d5d2`](6f5d5d2),
[`40359eb`](40359eb),
[`e7b30c1`](e7b30c1)]:
    -   @graphiql/react@0.37.4
    -   @graphiql/plugin-doc-explorer@0.4.2
    -   @graphiql/plugin-history@0.4.2

## @graphiql/plugin-code-exporter@5.1.2

### Patch Changes

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

## @graphiql/plugin-doc-explorer@0.4.2

### Patch Changes

- [#4231](#4231)
[`6f5d5d2`](6f5d5d2)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix
degraded type declarations in published packages

Both packages import from `@graphiql/react` at build time but only
declared it as a peer dependency. Yarn workspaces topologically orders
builds via `dependencies`/`devDependencies`, not `peerDependencies`, so
on a clean checkout these plugins built before `@graphiql/react` had
emitted its `dist/*.d.ts`. `vite-plugin-dts` then ran `tsc` against
unresolved `@graphiql/react` imports, fell back to `any` for any return
type that flowed through `useGraphiQL`, and published `.d.ts` artifacts
where hooks like `useDocExplorer` and `useDocExplorerActions` resolved
to `() => any` instead of their real shapes.

Adding `@graphiql/react` as a `devDependency` matches the pattern
already in `@graphiql/plugin-explorer` and
`@graphiql/plugin-code-exporter` and lets the build run in topological
order.

- [#4140](#4140)
[`40359eb`](40359eb)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove
`react-compiler-runtime` peer dependency

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

## @graphiql/plugin-explorer@5.1.2

### Patch Changes

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

## @graphiql/plugin-history@0.4.2

### Patch Changes

- [#4231](#4231)
[`6f5d5d2`](6f5d5d2)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix
degraded type declarations in published packages

Both packages import from `@graphiql/react` at build time but only
declared it as a peer dependency. Yarn workspaces topologically orders
builds via `dependencies`/`devDependencies`, not `peerDependencies`, so
on a clean checkout these plugins built before `@graphiql/react` had
emitted its `dist/*.d.ts`. `vite-plugin-dts` then ran `tsc` against
unresolved `@graphiql/react` imports, fell back to `any` for any return
type that flowed through `useGraphiQL`, and published `.d.ts` artifacts
where hooks like `useDocExplorer` and `useDocExplorerActions` resolved
to `() => any` instead of their real shapes.

Adding `@graphiql/react` as a `devDependency` matches the pattern
already in `@graphiql/plugin-explorer` and
`@graphiql/plugin-code-exporter` and lets the build run in topological
order.

- [#4140](#4140)
[`40359eb`](40359eb)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove
`react-compiler-runtime` peer dependency

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

- Updated dependencies
\[[`463df14`](463df14)]:
    -   @graphiql/toolkit@0.12.0

## @graphiql/react@0.37.4

### Patch Changes

- [#4181](#4181)
[`f1a210e`](f1a210e)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix schema
prop to skip introspection when IntrospectionQuery data is provided

Previously, passing an `IntrospectionQuery` result as the `schema` prop
would still trigger a network introspection request. The
`shouldIntrospect` check only recognized `GraphQLSchema` instances (via
`isSchema`), not raw introspection data. Now, when an
`IntrospectionQuery` is passed, a schema is built from it directly using
`buildClientSchema` and introspection is skipped.

- [#4140](#4140)
[`40359eb`](40359eb)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove
`react-compiler-runtime` peer dependency

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

- Updated dependencies
\[[`914a547`](914a547),
[`463df14`](463df14),
[`4bb7909`](4bb7909),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1
    -   @graphiql/toolkit@0.12.0
    -   monaco-graphql@1.7.4

## graphql-language-service@5.5.1

### Patch Changes

- [#3882](#3882)
[`914a547`](914a547)
Thanks [@bensengupta](https://github.com/bensengupta)! - Fix off-by-one
when hovering over token

- [#4222](#4222)
[`10f66d5`](10f66d5)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and
update graphql-config dependency

## graphql-language-service-server@2.14.9

### Patch Changes

- [#4187](#4187)
[`ca83879`](ca83879)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Bump
required TypeScript runtime dependency from `^5.3.3` to `^5.8.0`. This
is preparatory work for adopting the TypeScript Native Preview (tsgo)
compiler in a follow-up change, which tracks TypeScript 5.8 semantics.
In practice `^5.3.3` already resolved to TS 5.8+ for most consumers; the
new floor only affects consumers who pin TypeScript to 5.3–5.7 via
resolutions or overrides.

- [#4222](#4222)
[`10f66d5`](10f66d5)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and
update graphql-config dependency

- Updated dependencies
\[[`914a547`](914a547),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1

## monaco-graphql@1.7.4

### Patch Changes

- [#4225](#4225)
[`4bb7909`](4bb7909)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix hover
crashing on the first line of a query

`GraphQLWorker.doHover` was passing 0-indexed positions to `getRange`,
which expects a 1-indexed `SourceLocation` (per the GraphQL spec). On
the first line this caused `Expected Parser stream to be available` to
be logged and hover to return `null`. On other lines it returned the
range of the previous line's last token rather than the token under the
cursor. Use `getTokenAtPosition` to compute the actual token range
instead.

- Updated dependencies
\[[`914a547`](914a547),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1

## vscode-graphql@0.13.3

### Patch Changes

- [#4183](#4183)
[`2ef9389`](2ef9389)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code
extension publishing scripts

- Updated dependencies
\[[`ca83879`](ca83879),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service-server@2.14.9

## vscode-graphql-execution@0.3.3

### Patch Changes

- [#4183](#4183)
[`2ef9389`](2ef9389)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code
extension publishing scripts

- [#4222](#4222)
[`10f66d5`](10f66d5)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and
update graphql-config dependency

## vscode-graphql-syntax@1.3.9

### Patch Changes

- [#4183](#4183)
[`2ef9389`](2ef9389)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code
extension publishing scripts

- [#4143](#4143)
[`7979bf5`](7979bf5)
Thanks [@Netail](https://github.com/Netail)! - Add syntax highlighting
support for subscription operations.

- [#4144](#4144)
[`f7e2a56`](f7e2a56)
Thanks [@jsmnbom](https://github.com/jsmnbom)! - Add `text.html.vue` as
inline injection target.

[This PR](vuejs/language-tools#5856) broke
tooling by changing the vue grammar scope from `source.vue` to
`text.html.vue`. This adds `text.html.vue` as an additional injection
target for GraphQL syntax highlighting so that it works in both cases.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@trevor-scheer