@urql/core

Patch Changes

• ⚠️ Fix incorrect JSON stringification of objects from different JS contexts. This could lead to invalid variables being generated in the Vercel Edge runtime specifically Submitted by @SoraKumo001 (See #3453)

Minor Changes

• Add option to enable persisted-operations for subscriptions Submitted by @JoviDeCroock (See #3549)

Minor Changes

• Try to parse text/plain content-type as JSON before bailing out with an error Submitted by @JoviDeCroock (See #3430)

Patch Changes

• Explicitly unblock client.reexecuteOperation calls to allow stalled operations from continuing and re-executing. Previously, this could cause @urql/exchange-graphcache to stall if an optimistic mutation led to a cache miss Submitted by @kitten (See #3363)

Patch Changes

• Updated dependencies (See #3520, #3553, and #3520)
  • @urql/core@5.0.0

Patch Changes

• Warn about cached persisted-miss results in development, when a persistedExchange() sees a persisted-miss error for a result that's already seen a persisted-miss error (i.e. two misses). This shouldn't happen unless something is caching persisted errors and we should warn about this appropriately Submitted by @kitten (See #3442)

Patch Changes

• Add case for subscriptionExchange to handle GraphQLError[] received in the error observer callback. Note: This doesn't strictly check for the GraphQLError shape and only checks for arrays and receiving errors in the ExecutionResult on the next observer callback is preferred and recommended for transports Submitted by @kitten (See #3346)

Minor Changes

• Add back the reexecute function Submitted by @JoviDeCroock (See #3472)

Patch Changes

• Updated dependencies (See #3514, #3505, #3499, and #3515)
  • @urql/core@4.3.0

Minor Changes

• Allow persisted query logic to be skipped by the persistedExchange if the passed generateHash function resolves to a nullish value. This allows (A)PQ to be selectively disabled for individual operations Submitted by @kitten (See #3324)

Patch Changes

• Updated dependencies (See #3317 and #3308)
  • @urql/core@4.1.0

Minor Changes

• Update formatDocument to output FormattedNode type mapping. The formatter will now annotate added __typename fields with _generated: true, place selection nodes' directives onto a _directives dictionary, and will filter directives to not include "_" underscore prefixed directives in the final query. This prepares us for a feature that allows enhanced client-side directives in Graphcache Submitted by @kitten (See #3317)

Patch Changes

• Add OperationContext.optimistic flag as an internal indication on whether a mutation triggered an optimistic update in @urql/exchange-graphcache's cacheExchange Submitted by @kitten (See #3308)

Patch Changes

• Replace File and Blob objects with null in variables if multipart request will be started Submitted by @kitten (See #3169)
• Strictly deduplicate cache-and-network and network-only operations, while a non-stale response is being waited for Submitted by @kitten (See #3157)
• ⚠️ Fix boundary stopping multipart/mixed streams when it randomly occurs in response payloads Submitted by @kitten (See #3155)
• Improve dispatching of arbitrary operations using reexecuteOperation Submitted by @kitten (See #3159)

Patch Changes

• ⚠️ Fix queryStore and subscriptionStore not subscribing when writable calls its StartStopNotifier. This caused both stores to be inactive and become unresponsive when they’ve been unsubscribed from once, as they wouldn’t be able to restart their subscriptions to the Client Submitted by @kitten (See #3331)

Patch Changes

• ⚠️ Fix hasNext being defaulted to false when a new subscription event is received on the subscriptionExchange that doesn't have hasNext set Submitted by @kitten (See #3137)

Patch Changes

• Apply shallow difference patch from React bindings to @urql/preact (See: #3195) Submitted by @kitten (See #3266)

Patch Changes

• Handle fetch rejections in makeFetchSource and properly hand them over to CombinedErrors Submitted by @kitten (See #3131)

Patch Changes

• ⚠️ Fix incremental delivery payloads not merging data correctly, or not handling patches on root results Submitted by @kitten (See #3124)

Patch Changes

• Publish with npm provenance Submitted by @kitten (See #3180)

Patch Changes

• ⚠️ Fix format of map form data field on multipart upload requests. This was erroneously set to a string rather than a string tuple Submitted by @kitten (See #3118)

Major Changes

• Update OperationResult.hasNext and OperationResult.stale to be required fields. If you have a custom exchange creating results, you'll have to add these fields or use the makeResult, mergeResultPatch, or makeErrorResult helpers Submitted by @kitten (See #3061)
• Move handler, which combines subscription events, from mutationStore to subscriptionStore. It’s accidentally been defined and implemented on the wrong store and was meant to be on subscriptionStore Submitted by @kitten (See #3078)

Minor Changes

• Allow mutations to update their results in bindings when hasNext: true is set, which indicates deferred or streamed results Submitted by @kitten (See #3103)

Patch Changes

• ⚠️ Fix source maps included with recently published packages, which lost their sourcesContent, including additional source files, and had incorrect paths in some of them Submitted by @kitten (See #3053)
• Upgrade to wonka@^6.3.0 Submitted by @kitten (See #3104)
• Add TSDocs to all urql bindings packages Submitted by @kitten (See #3079)
• Updated dependencies (See #3101, #3033, #3054, #3053, #3060, #3081, #3039, #3104, #3082, #3097, #3061, #3055, #3085, #3079, #3087, #3059, #3055, #3057, #3050, #3062, #3051, #3043, #3063, #3054, #3102, #3097, #3106, #3058, and #3062)
  • @urql/core@4.0.0

Major Changes

• Remove the default Client from Context. Previously, urql kept a legacy default client in its context, with default exchanges and calling an API at /graphql. This has now been removed and you will have to create your own Client if you were relying on this behaviour Submitted by @JoviDeCroock (See #3033)

Minor Changes

• Allow mutations to update their results in bindings when hasNext: true is set, which indicates deferred or streamed results Submitted by @kitten (See #3103)

Patch Changes

• ⚠️ Fix source maps included with recently published packages, which lost their sourcesContent, including additional source files, and had incorrect paths in some of them Submitted by @kitten (See #3053)
• Upgrade to wonka@^6.3.0 Submitted by @kitten (See #3104)
• Add TSDocs to all urql bindings packages Submitted by @kitten (See #3079)
• Updated dependencies (See #3101, #3033, #3054, #3053, #3060, #3081, #3039, #3104, #3082, #3097, #3061, #3055, #3085, #3079, #3087, #3059, #3055, #3057, #3050, #3062, #3051, #3043, #3063, #3054, #3102, #3097, #3106, #3058, and #3062)
  • @urql/core@4.0.0

Major Changes

• Remove defaultExchanges from @urql/core and make exchanges a required property on Client construction. In doing so we make the urql package more tree-shakeable as the three default exchanges are in no code paths meaning they can be removed if not used. A migration would look as follows if you are currently creating a client without exchanges

  import { createClient, cacheExchange, fetchExchange } from '@urql/core';
  
  const client = createClient({
    url: '',
    exchanges: [cacheExchange, fetchExchange],
  });
  

  Submitted by @JoviDeCroock (See #3033)

• Update subscriptionExchange to receive FetchBody instead. In the usual usage of subscriptionExchange (for instance with graphql-ws) you can expect no breaking changes. However, the key and extensions field has been removed and instead the forwardSubscription function receives the full Operation as a second argument Submitted by @kitten (See #3054)

• Remove dependence on graphql package and replace it with @0no-co/graphql.web, which reduces the default bundlesize impact of urql packages to a minimum. All types should remain compatible, even if you use graphql elsewhere in your app, and if other dependencies are using graphql you may alias it to graphql-web-lite Submitted by @kitten (See #3097)

• Update OperationResult.hasNext and OperationResult.stale to be required fields. If you have a custom exchange creating results, you'll have to add these fields or use the makeResult, mergeResultPatch, or makeErrorResult helpers Submitted by @kitten (See #3061)

• Remove getOperationName export from @urql/core Submitted by @kitten (See #3062)

Minor Changes

• Return a new OperationResultSource from all Client methods (which replaces PromisifiedSource on shortcut methods). This allows not only toPromise() to be called, but it can also be used as an awaitable PromiseLike and has a .subscribe(onResult) method aliasing the subscribe utility from wonka Submitted by @kitten (See #3060)
• Update subscriptionExchange to support incremental results out of the box. If a subscription proactively completes, results are also now updated with hasNext: false Submitted by @kitten (See #3055)
• Implement text/event-stream response support. This generally adheres to the GraphQL SSE protocol and GraphQL Yoga push responses, and is an alternative to multipart/mixed Submitted by @kitten (See #3050)
• Implement GraphQL Multipart Request support in @urql/core. This adds the File/Blob upload support to @urql/core, which effectively deprecates @urql/exchange-multipart-fetch Submitted by @kitten (See #3051)
• Support GraphQLRequest.extensions as spec-extensions input to GraphQL requests Submitted by @kitten (See #3054)
• Allow subscriptions to be handled by the fetchExchange when fetchSubscriptions is turned on Submitted by @kitten (See #3106)
• Deprecate the dedupExchange. The functionality of deduplicating queries and subscriptions has now been moved into and absorbed by the Client. Previously, the Client already started doing some work to share results between queries, and to avoid dispatching operations as needed. It now only dispatches operations strictly when the dedupExchange would allow so as well, moving its logic into the Client Submitted by @kitten (See #3058)

Patch Changes

• Deduplicate operations as the dedupExchange did; by filtering out duplicate operations until either the original operation has been cancelled (teardown) or a first result (without hasNext: true) has come in Submitted by @kitten (See #3101)
• ⚠️ Fix source maps included with recently published packages, which lost their sourcesContent, including additional source files, and had incorrect paths in some of them Submitted by @kitten (See #3053)
• Allow makeOperation to be called with a partial OperationContext when it’s called to copy an operation. When it receives an Operation as a second argument now, the third argument, the context, will be spread into the prior operation.context Submitted by @kitten (See #3081)
• Move multipart/mixed to end of Accept header to avoid cauing Yoga to unnecessarily use it Submitted by @JoviDeCroock (See #3039)
• Upgrade to wonka@^6.3.0 Submitted by @kitten (See #3104)
• Update Exchange contract and composeExchanges utility to remove the need to manually call share on either incoming Source<Operation> or forward()’s Source<OperationResult>. This is now taken care of internally in composeExchanges and should make it easier for you to create custom exchanges and for us to explain them Submitted by @kitten (See #3082)
• Add support for graphql’s built-in TypedQueryDocumentNode typings for type inference Submitted by @kitten (See #3085)
• Add missing type exports of SSR-related types (SerializedResult, SSRExchangeParams, SSRExchange, and SSRData) to @urql/core's type exports Submitted by @kitten (See #3079)
• Allow any object fitting the GraphQLError shape to rehydrate without passing through a GraphQLError constructor in CombinedError Submitted by @kitten (See #3087)
• Add missing hasNext and stale passthroughs on caching exchanges Submitted by @kitten (See #3059)
• ⚠️ Fix incremental results not merging errors from subsequent non-incremental results Submitted by @kitten (See #3055)
• Add logic for request.extensions.persistedQuery to @urql/core to omit sending query as needed Submitted by @kitten (See #3057)
• ⚠️ Fix incorrect operation name being picked from queries that contain multiple operations Submitted by @kitten (See #3062)
• Replace fetch source implementation with async generator implementation, based on Wonka's fromAsyncIterable. This also further hardens our support for the "Incremental Delivery" specification and refactors its implementation and covers more edge cases Submitted by @kitten (See #3043)
• Ensure network errors are always issued with CombinedErrors, while downstream errors are re-thrown Submitted by @kitten (See #3063)
• Refactor Client result source construction code and allow multiple mutation results, if result.hasNext on a mutation result is set to true, indicating deferred or streamed results Submitted by @kitten (See #3102)
• Remove dependence on import { visit } from 'graphql'; with smaller but functionally equivalent alternative Submitted by @kitten (See #3097)

Patch Changes

• ⚠️ Fix ssrExchange bug which prevented staleWhileRevalidate from sending off requests as network-only requests, and caused unrelated network-only operations to be dropped, by @kitten (See #2691)
• Allow URL limit for GET requests to be bypassed using preferGetMethod: 'force' rather than the default true or 'within-url-limit' value, by @kitten (See #2692)
• ⚠️ Fix operation identities preventing users from deeply cloning operation contexts. Instead, we now use a client-wide counter (rolling over as needed). While this changes an internal data structure in @urql/core only, this change also affects the offlineExchange in @urql/exchange-graphcache due to it relying on the identity being previously an object rather than an integer, by @kitten (See #2732)

Patch Changes

• ⚠️ Fix type-generation, with a change in TS/Rollup the type generation took the paths as src and resolved them into the types dir, by @JoviDeCroock (See #2870)
• Updated dependencies (See #2872, #2870, and #2871)
  • @urql/core@3.1.1

Patch Changes

• ⚠️ Fix variable types in core makeOperation, by @JoviDeCroock (See #2665)

Patch Changes

• Update generics for components, by @JoviDeCroock (See #2663)
• Updated dependencies (See #2665)
  • @urql/core@3.0.3

Patch Changes

• ⚠️ Fix case where maskTypename would not traverse down when the root query-field does not contain a __typename, by @mlecoq (See #2643)

Patch Changes

• ⚠️ fix setting a client default requestPolicy, we set context.requestPolicy: undefined from our bindings which makes a spread override the client-set default, by @JoviDeCroock (See #2634)

Patch Changes

• Tweak the variables type for when generics only contain nullable keys, by @JoviDeCroock (See #2623)

Major Changes

• Goodbye IE11! 👋 This major release removes support for IE11. All code that is shipped will be transpiled much less and will not be ES5-compatible anymore, by @kitten (See #2504)
• Implement stricter variables types, which require variables to always be passed and match TypeScript types when the generic is set or inferred. This is a breaking change for TypeScript users potentially, unless all types are adhered to, by @kitten (See #2607)
• Upgrade to Wonka v6 (wonka@^6.0.0), which has no breaking changes but is built to target ES2015 and comes with other minor improvements. The library has fully been migrated to TypeScript which will hopefully help with making contributions easier!, by @kitten (See #2504)

Patch Changes

• Updated dependencies (See #2551, #2504, #2619, #2607, and #2504)
  • @urql/core@3.0.0

Major Changes

• Goodbye IE11! 👋 This major release removes support for IE11. All code that is shipped will be transpiled much less and will not be ES5-compatible anymore, by @kitten (See #2504)
• Remove support for options on the Client and Client.createOperationContext. We've noticed that there's no real need for createOperationContext or the options on the Client and that it actually encourages modifying properties on the Client that are really meant to be modified dynamically via exchanges, by @kitten (See #2619)
• Implement stricter variables types, which require variables to always be passed and match TypeScript types when the generic is set or inferred. This is a breaking change for TypeScript users potentially, unless all types are adhered to, by @kitten (See #2607)
• Upgrade to Wonka v6 (wonka@^6.0.0), which has no breaking changes but is built to target ES2015 and comes with other minor improvements. The library has fully been migrated to TypeScript which will hopefully help with making contributions easier!, by @kitten (See #2504)

Minor Changes

• Remove the babel-plugin-modular-graphql helper, this because the graphql package hasn't converted to ESM yet which gives issues in node environments, by @JoviDeCroock (See #2551)