Skip to content
This repository has been archived by the owner on Mar 14, 2022. It is now read-only.

Latest commit

 

History

History
291 lines (160 loc) · 14.6 KB

CHANGELOG.md

File metadata and controls

291 lines (160 loc) · 14.6 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.7.0] - 2020-04-16

This release migrates our dependency on urql to v1.5.1. It also migrates our devDependency on bs-platform (the BuckleScript compiler), to v7.2.2. While we don't expect this to affect end users still on BuckleScript v6, there may be small bugfixes and optimizations coming in the near future to support this migration.

Added

  • Add support for Promise-based methods query and mutation on the Client. This allows users to interact with Client operation results as Js.Promise.t rather than Wonka.sourceT. PR by @parkerziegler here.
  • Add bindings for the useClient hook. PR by @parkerziegler here.

Changed

  • Migrate local devDependency on bs-platform to v7.2.2 and in-repo compilation target to es6. PR by @parkerziegler here.
  • Remove peerDependency on bs-fetch.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.6.0...v1.7.0

[1.6.0] - 2020-03-30

This release migrates our dependency on urql to v1.4.0. This adds support for setting a default requestPolicy on the Client, in addition to setting up polling for your GraphQL queries using the pollInterval argument to useQuery and the Query component.

Added

  • Add option to set a default requestPolicy on the Client. PR by @JoviDeCroock here.
  • Add pollInterval argument to useQuery hook and Query component. PR by @JoviDeCroock here.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.5.0...v1.6.0

[1.5.0] - 2020-01-11

This release migrates our dependency on urql to v1.3.0. As such, we now have support for GraphQL extensions, custom fetch implementations, and adjustable operation contexts for queries and mutations.

Added

  • Access GraphQL extensions returned by your GraphQL API inside all hooks and componentts. PR by @parkerziegler here.
  • Add support for a custom fetch implementation to clientOptions. Pr by @parkerziegler here.
  • Support an optional context argument to executeQuery and executeMutation, in addition to an optional initial context prop / argument for the Query component and useQuery hook. PRs by @parkerziegler here and here.

Fixed

  • Improved documentation on the reason-urql API. PR by @parkerziegler here.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.4.1...v1.5.0

[1.4.1] - 2019-12-16

This release fixes a small bug with requestPolicy in useQuery. We weren't properly converting the polymorphic variants passed by a user to their JS string representation, which led to improper request policies being used by the urql Client.

Fixed

  • Properly unwrap user-supplied requestPolicy to the matching JS string representation. PR by @baransu here.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.4.0...v1.4.1

[1.4.0] - 2019-12-08

This release adds support for a useDynamicMutation hook, which allows users to pass variables to the executeMutation function returned by the hook at execution time, as opposed to at render time as useMutation does.

Added

  • Add useDyanmicMutation hook to support applying variables when calling executeMutation. PR by @Schmavery and @sgrove here.

Fixed

  • Restore CI by migrating off of GitHub Actions to Travis CI. PR by @parkerziegler here.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.3.0...v1.4.0

[1.3.0] - 2019-11-12

This release migrates us to [email protected] and ensures reason-urql is compatible for codebases using latest bs-platform.

Added

  • Documentation on using graphql_ppx_re with reason-urql. PR by @huy-nguyen here.
  • Improved Getting Started documentation. PR by @parkerziegler here.

Changed

  • Fix type for pause argument to Query component for [email protected]. PR by @gugahoa here.
  • Migrate to [email protected] in source. Fix compiler warnings. Rename partialOperationContextFn to executeQuery. This is a breaking change.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.2.0...v1.3.0

[1.2.0] - 2019-10-29

This release upgrades our urql dependency to 1.2.0 and picks up a handful of small bugfixes introduced in that release.

Added

  • The operationContext object now has a meta property on it, containing fields for source, cacheOutcome, and networkLatency. These fields are likely to be deprecated in the next minor release and moved to bs-urql-devtools-exchange.

Changed

  • urql dependency upgraded to v1.2.0!
  • bs-platform dependency upgraded to v5.2.1! PR by @parkerziegler here.
  • Some cmall changes to spurce up the example projects!

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.1.0...v1.2.0

[1.1.0] - 2019-10-17

This release adds experimental support for server-side rendering with the addition of bindings for the ssrExchange.

Added

  • Bindings for ssrExchange and the suspense option on the Client.make function. PR by @parkerziegler here.
  • Initial docs for server side rendering support. PR by @parkerziegler here.

Changed

  • urql dependency upgraded to v1.1.3!

Fixed

  • Minor docs fix by for the Client module. PR by @robinweser here.
  • bsconfig.json and package.json files from the examples directory are no longer published to npm.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.0.2...v1.1.0

[1.0.2] - 2019-10-05

This release makes a small change around the API for CombinedError. Specifically, the module type t for CombinedError now refers to the record exposed by the module rather than the Js.t / OCaml class binding urql's native CombinedError class. Better documentation for CombinedError was also added.

Added

  • More documentation on CombinedError in the API docs. PR by @Schmavery and @parkerziegler here.

Changed

  • CombinedError.t now references the record exposed by the CombinedError module containing fields for message, networkError, graphQLErrors, and message. PR by @Schmavery and @parkerziegler here.

Fixed

  • Capitalization / casing for the graphQLErrors field on CombinedError.t. Previously this was bound as graphqlErrors, which would always result in None being returned as urql has no graphqlErrors field. PR by @Schmavery here.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.0.1...v1.0.2

[1.0.1] - 2019-09-26

This release removes bs-fetch as a dependency such that it doesn't conflict with a user's local copy of bs-fetch. Since we only use bs-fetch for type checking fetchOptions, it can safely be included as a devDependency. This release also adds a message field on the combinedError record to provide users access to the raw error string from urql.

Removed

  • Dependency on bs-fetch. bs-fetch is now a devDependency for reason-urql and can also be installed as a peerDependency if you want to use a different version in your app. PR by @parkerziegler and @gugahoa here.

Added

  • message field on CombinedError.combinedError. This represents the raw string message returned by the urql client for your requests. PR by @Schmavery here.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.0.0...v1.0.1

[1.0.0] - 2019-09-18

This release represents the first stable reason of reason-urql. From this point forward we'll be starting to enforce semantic versioning for all changes. Thank you so much to all of the contributors who helped us to achieve this milestone!

Added

  • A Getting Started guide to help first time users of reason-urql get up and running.

Changed

  • The Error(e) constructor of the response variant has been moved above the Data(d) constructor to better match urql's JS API, where uses check for error responses on the GraphQL request before operating on data.
  • The Types and Client.Types modules were renamed to UrqlTypes and Client.ClientTypes to avoid namespace collisions with user-defined Types modules.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.0.0-beta.3...v1.0.0

[1.0.0-beta.3] – Type Inference on Client.execute* Methods - 2019-08-17

This release adds improved type inference around the Client's execute* methods (i.e. executeQuery, executeMutation, and executeSubscription). Responses will now be fully type checked at compile time. This release also pins the bound version of urql to 1.0.5 to address a regression that occurs when using urql > 1.2.0.

Changed

  • Add proper type inference to Client.execute* methods. This now involves passing the full graphql_ppx module to the Client such that it can grab the parse method off of it to properly infer the response. This mimics exactly how the components and hooks work.
  • Reorganize types to reduce redundancy and ensure unique generation of [@bs.deriving abstract] accessors. This change is mostly internal, but it begins to isolated types used by different modules into submodules. For example, rather than all types living in the top-level Types module, certain types reserved for particular domains, i.e. the Client, live in a submodule i.e. Client.Types.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.0.0-beta.2...v1.0.0-beta.3

[1.0.0-beta.2] – CombinedError and FetchOption Function - 2019-07-22

This release adds small improvements around client.fetchOptions and the CombinedError API.

Changed

  • The FetchFn variant of the client's fetchOptions argument now supports calling the function at runtime of the client rather than invoking it early in order to pass a fetchOptions object to urql.
  • UrqlCombinedError is now properly bound using OCaml classes. A helper was added to convert the CombinedError Js.t to a record type to allow for nicer, typesafe access.

Diff

https://github.com/FormidableLabs/reason-urql/compare/v1.0.0-beta.1...v1.0.0-beta.2

[1.0.0-beta.1] – 🎣 Hooks - 2019-07-06

This release includes support for urql hooks, including useQuery, useMutation, and useSubscription. It also includes additions to support proper type inference of GraphQL requests, such that users get compile-time guarantees that they are accessing data in a fully type-safe way.

Added

  • Bindings for useQuery, useMutation, and useSubscription.
  • Bindings for SubscriptionWithHandler, which is to be used in cases where a custom handler function is passed to the Subscription component to accumulate subscriptions.
  • The top-level urql context object, which exposes a Consumer and Provider, is now exposed to the user.

Changed

  • Migrated all components and examples to latest ReasonReact syntax ("jsx: 3").
  • Add proper type inference for hooks and components. This is achieved by passing the entire graphql_ppx module to the hooks, which allows them to use the parse method to infer the return type of data from the request.

Diff

https://github.com/parkerziegler/reason-urql/compare/v1.0.0-beta...v1.0.0-beta.1

[1.0.0-beta] - 🎉 v1 (Beta) - 2019-05-16

This represents the beta release of v1, which provides support for urql v1.

Added

  • Bindings for Query, Mutation, and Subscription components.
  • Bindings for Client with support for exchanges.
  • Bindings for Provider.
  • Bindings for urql's type interfaces, utils, and helpers.
  • Examples for Query, Mutation, Subscription, exposed exchanges, custom exchanges, and imperative Client methods.
  • First tests for UrqlClient.

Diff

https://github.com/parkerziegler/reason-urql/compare/v0.1.1...v1.0.0-beta

[0.1.1] - Coverage 💅 - 2019-01-29

Added

  • Additional tests for Query, Mutation, Connect, and Client.

Fixed

  • The invalidate cache operation supplied to Connect now properly accepts a single, optional labelled argument ~query: Query.urqlQuery. This will now type check properly thanks to a final positional unit parameter in the type definition.

Diff

https://github.com/parkerziegler/reason-urql/compare/v0.1.0...v0.1.1

[0.1.0] – We're Stable(ish)! - 2018-12-07

Welcome to v0.1.0 of reason-urql. With this release, we are moving into a stable state and will continue onwards with standard semantic versioning.

Added

  • Automated builds with Travis CI.
  • Automated coverage reporting with Coveralls.
  • Unit tests for UrqlQuery, UrqlMutation, UrqlConnect, UrqlClient, and UrqlProvider.
  • Codified utilities for making tests more concise – see TestUtils.re.
  • Zero-config, hot reloading in the example project.
  • Small, non-breaking changes to the API.

Diff

https://github.com/parkerziegler/reason-urql/compare/v0.1.0-beta...v0.1.0

[0.1.0-beta] - GraphQL, meet Reason - 2018-10-07

This is the initial beta release of reason-urql! These bindings are currently untested and should not be used in production just yet. Come help us by writing tests, opening issues, and filing PRs. Thanks!