Prepare for v1.1.0 release.

Author: parkerziegler

.npmignore

@@ -5,9 +5,7 @@
 !README.md
 !CHANGELOG.md
 !CONTRIBUTING.md
-!bsconfig.json
-!package.json
+!/bsconfig.json
+!/package.json
 # exclude BuckleScript output
-src/**/*.bs.js
-examples/**/package.json
-examples/**/bsconfig.json
+src/**/*.bs.js

CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [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](https://github.com/FormidableLabs/reason-urql/pull/111).
+- Initial docs for server side rendering support. PR by @parkerziegler [here](https://github.com/FormidableLabs/reason-urql/pull/111).
+
+### Changed
+
+- `urql` dependency upgraded to v1.1.3!
+
+### Fixed
+
+- Minor docs fix by for the `Client` module. PR by @robinweser [here](https://github.com/FormidableLabs/reason-urql/pull/112).
+- `bsconfig.json` and `package.json` files from the `examples` directory are no longer published to `npm`.
+
 ## [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.

__tests__/UrqlClient_test.re

@@ -75,6 +75,15 @@ describe("UrqlClient", () => {
     });
   });
 
+  describe("Client with suspense flag", () =>
+    it("should accept a suspense flag to enable experimental SSR mode", () => {
+      let client =
+        Client.make(~url="https://localhost:3000", ~suspense=true, ());
+
+      Expect.(expect(client) |> toMatchSnapshot);
+    })
+  );
+
   describe("Client with exchanges provided", () => {
     it("should instantiate a client with exchanges", () => {
       let client =

__tests__/__snapshots__/UrqlClient_test.bs.js.snap

@@ -83,4 +83,23 @@ Client {
 }
 `;
 
+exports[`UrqlClient Client with suspense flag should accept a suspense flag to enable experimental SSR mode 1`] = `
+Client {
+  "activeOperations": Object {},
+  "createOperationContext": [Function],
+  "createRequestOperation": [Function],
+  "dispatchOperation": [Function],
+  "exchange": [Function],
+  "executeMutation": [Function],
+  "executeQuery": [Function],
+  "executeSubscription": [Function],
+  "fetchOptions": undefined,
+  "operations$": [Function],
+  "reexecuteOperation": [Function],
+  "results$": [Function],
+  "suspense": true,
+  "url": "https://localhost:3000",
+}
+`;
+
 exports[`UrqlClient ssrExchange should exist and be callable 1`] = `[Function]`;

docs/api.md

@@ -729,20 +729,7 @@ If using the `ssrExchange`, it should be placed after any caching exchanges, lik
 ```reason
 open ReasonUrql;
 
-/* Mocking up some fake cache data on the server. */
-let json = Js.Dict.empty();
-Js.Dict.set(json, "key", Js.Json.number(1.));
-Js.Dict.set(json, "key2", Js.Json.number(2.));
-let data = Js.Json.object_(json);
-let serializedResult = Exchanges.serializedResult(~data, ());
-
-let initialState = Js.Dict.empty();
-Js.Dict.set(initialState, "query", serializedResult);
-
-/* Create the initialState that will be passed to the ssrExchange. */
-let ssrExchangeOpts = Exchanges.ssrExchangeOpts(~initialState, ());
-
-let ssrCache = Exchanges.ssrExchange(~ssrExchangeOpts, ());
+let ssrCache = Exchanges.ssrExchange();
 
 let client = Client.make(
   ~url="http://localhost:3000",
@@ -774,7 +761,7 @@ let ssrCache = Exchanges.ssrExchange(~ssrExchangeOpts, ());
 let extractedData = Exchanges.restoreData(~exchange=ssrCache, ~restore=urqlData);
 ```
 
-This part of the API is still quite experimental, as server-side rendering in Reason with NextJS is still in its e=infancy. Use with caution. For more information, read `urql`'s server-side rendering guide [here](https://github.com/FormidableLabs/urql/blob/master/docs/basics.md#server-side-rendering).
+This part of the API is still quite experimental, as server-side rendering in Reason with NextJS is still in its infancy. Use with caution. For more information, read `urql`'s server-side rendering guide [here](https://github.com/FormidableLabs/urql/blob/master/docs/basics.md#server-side-rendering).
 
 #### `composeExchanges`