Utility to build a fetcher for GraphiQL
Changelog | API Docs | NPM | Discord
graphql@graphiql/toolkitThis is a general purpose library for building GraphQL IDEs. It's being used by
other packages like graphiql and @graphiql/react and also provides utilities
that are useful when working with these packages.
createFetcher : a utility for creating a
fetcher prop implementation for HTTP GET, POST including multipart,
websockets fetcher7054591 Thanks @dimaMachina! - revert https://github.com/graphql/graphiql/pull/3946 to have support multiple embedded graphiql instances on the same page1adc40c Thanks @dimaMachina! - bump eslint, eslint-plugins and fix new warnings#3747 21c4409 Thanks @dimaMachina! - do not include require statements in ESM build, include import in esm and require in cjs builds
make getWsFetcher, createWebsocketsFetcherFromUrl async
#3746 2ad4e75 Thanks @dimaMachina! - compile with tsup instead of tsc
#3682 6c9f0df Thanks @yaacovCR! - Support v17 of graphql-js from 17.0.0-alpha.2 forward.
Includes support for the latest incremental delivery response format. For further details, see https://github.com/graphql/defer-stream-wg/discussions/69.
56c6f45 Thanks @dimaMachina! - prefer localStorage over window.localStorageffb6486d Thanks @heyacherry! - Add a new utility function createLocalStorage that creates a local storage with support for custom namespaces#3113 2e477eb2 Thanks @B2o5T! - replace .forEach with for..of
#3109 51007002 Thanks @B2o5T! - enable no-floating-promises eslint rule
#3046 b9c13328 Thanks @B2o5T! - Prefer .at() method for index access
#3042 881a2024 Thanks @B2o5T! - Prefer String#slice() over String#substr() and String#substring()
#2931 f7addb20 Thanks @B2o5T! - enable no-negated-condition and no-else-return rules
#2923 695100bd Thanks @TheMightyPenguin! - Remove side-effect in StorageAPI that overrides localStorage.clear
#2937 c70d9165 Thanks @B2o5T! - enable unicorn/prefer-includes
#2965 0669767e Thanks @B2o5T! - enable unicorn/prefer-optional-catch-binding rule
#2936 18f8e80a Thanks @B2o5T! - enable lonely-if/unicorn/lonely-if rules
#2938 6a9d913f Thanks @B2o5T! - enable unicorn/throw-new-error rule
e244b782 Thanks @andreialecu! - Allow passing Headers for subscriptions into connection_init payload674bf3f8 Thanks @thomasheyenbrock! - Only remove namespaced items when clearing localStorage#2753 bfa90f24 Thanks @thomasheyenbrock! - Mark the graphql-ws peer dependency as optional (as it's only needed when the fetcher needs to support subscriptions)
#2751 8ab5fcd0 Thanks @thomasheyenbrock! - Correctly handle null in type-guard functions for Promise and Observable
48872a87 Thanks @thomasheyenbrock! - Handle execution when there is no document AST (because the query editor is empty or the query string contains syntax errors)#2694 e59ec32e Thanks @acao! - BREAKING: Don't pass shouldPersistHeaders anymore when invoking the fetcher function. This value can be looked up by consuming the EditorContext:
import { useEditorContext } from '@graphiql/react';
function MyComponent() {
const { shouldPersistHeaders } = useEditorContext();
// Do things...
}#2694 e59ec32e Thanks @acao! - Add a clear method to Storage classes
ea732ea8 Thanks @thomasheyenbrock! - Fix error formatting for websocket requests and make error formatting more generic in general#2419 84d8985b Thanks @thomasheyenbrock! - Move the fillLeafs utility function from graphiql into @graphiql/toolkit and deprecate the export from graphiql
#2419 84d8985b Thanks @thomasheyenbrock! - Move the mergeAst utility function from graphiql into @graphiql/toolkit and deprecate the export from graphiql
#2419 84d8985b Thanks @thomasheyenbrock! - Move the getSelectedOperationName utility function from graphiql into @graphiql/toolkit and deprecate the export from graphiql
8be164b1 Thanks @thomasheyenbrock! - Allow creating noop StorageAPI instances by passing null to the constructor#2412 c2e2f53d Thanks @thomasheyenbrock! - Move QueryStore from graphiql package to @graphiql/toolkit
#2412 c2e2f53d Thanks @thomasheyenbrock! - Move HistoryStore from graphiql package to @graphiql/toolkit
#2412 c2e2f53d Thanks @thomasheyenbrock! - Move StorageAPI from graphiql package to @graphiql/toolkit
bc3dc64c Thanks @benjdlambert! - Move graphql-ws dependency to a dynamic import, and add a nice error message when it's not installed#2401 60a744b1 Thanks @thomasheyenbrock! - move async helper functions and formatting functions over into the @graphiql/toolkit package
#2401 60a744b1 Thanks @thomasheyenbrock! - deprecate the unused shouldPersistHeaders property from fetcher options to be removed in the next major version
5b2c1b20 Thanks @benjie! - Fix TypeScript definition of FetcherParams to reflect that operationName is optionaldec207e7 #2017 Thanks @acao! - graphql-ws is now a peerDependency. It supports ~4.5.0 to the latest graphql-ws@5.5.5 and beyond. we suggest using the latest version!716cf786 #2010 Thanks @acao! - upgrade to graphql@16.0.0-experimental-stream-defer.5. thanks @saihaj!86795d5f Thanks @acao! - Remove bad type definition from subscriptions-transport-ws #1992 closes #19896a459f4c #1968 Thanks @acao! - Remove optionalDependencies entirely, remove subscriptions-transport-ws which introduces vulnerabilities, upgrade @n1ru4l/push-pull-async-iterable-iterator to 3.0.0, upgrade graphql-ws several minor versions - the graphql-ws@5.x upgrade will come in a later minor release.3f002710 #1840 Thanks @enisdenjo! - Use provided wsConnectionParams
94f16957 #1841 Thanks @enisdenjo! - Subscriptions async iterator completes and better error handling
dd9397e4 #1819 Thanks @acao! - GraphiQL.createClient() accepts custom legacyClient, exports typescript types, fixes #1800.
createGraphiQLFetcher now only attempts an graphql-ws connection when only subscriptionUrl is provided. In order to use graphql-transport-ws, you'll need to provide the legacyClient option only, and no subscriptionUrl or wsClient option.
6869ce77 #1816 Thanks @acao! - improve peer resolutions for graphql 14 & 15. 14.5.0 minimum is for built-in typescript types, and another method only available in 14.4.0d3278556 Thanks @harshithpabbati! - Move @graphiql/create-fetcher to @graphiql/toolkit because it doesn't need to be it's own package as @imolorhe pointed out1c119386: @defer, @stream, and graphql-ws support in a createGraphiQLFetcher utility (#1770)
@defer and @stream in GraphiQL itself on fetcher execution and when handling stream payloads@graphiql/toolkit for types and utilities used to compose GraphiQL and other related libraries@graphiql/create-fetcher to accept simplified parameters to generate a fetcher that covers the most commonly used graphql-over-http transport spec proposals. using meros for multipart http, and graphql-ws for websockets subscriptions.graphql and graphql-express experimental-defer-stream branch in development until it's merged@stream in different scenarioscreateGraphiQLFetcher