graphql-react - npm Package Compare versions

Comparing version 11.0.0 to 11.0.1

changelog.md

 # graphql-react changelog
 
+## 11.0.1
+
+### Patch
+
+- Updated Node.js support to `^10.17.0 || ^12.0.0 || >= 13.7.0`. This is only a correction; the dependency updates with breaking changes happened in previous versions.
+- Updated dependencies.
+- Simplified JSX boolean props in tests.
+- Improved event documentation.
+- Fixed an incorrect `reportCacheErrors` JSDoc parameter type.
+- Updated EditorConfig.
+
 ## 11.0.0
@@ -4,0 +15,0 @@

package.json

 {
   "name": "graphql-react",
-  "version": "11.0.0",
+  "version": "11.0.1",
   "description": "A GraphQL client for React using modern context and hooks APIs that is lightweight (< 3 KB size limited) but powerful; the first Relay and Apollo alternative with server side rendering.",
@@ -55,5 +55,5 @@ "license": "MIT",
   "engines": {
-    "node": "10 - 12 || >= 13.7"
+    "node": "^10.17.0 || ^12.0.0 || >= 13.7.0"
   },
-  "browserslist": "Node 10 - 12, Node >= 13.7, > 0.5%, not OperaMini all, not dead",
+  "browserslist": "Node 10.17 - 11 and Node < 11, Node 12 - 13 and Node < 13, Node >= 13.7, > 0.5%, not OperaMini all, not dead",
   "peerDependencies": {
@@ -64,3 +64,3 @@ "react": "^16.8.0",
   "dependencies": {
-    "@babel/runtime": "^7.9.6",
+    "@babel/runtime": "^7.10.2",
     "extract-files": "^8.1.0",
@@ -72,29 +72,29 @@ "fnv1a": "^1.0.1",
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.6",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.9.6",
-    "@babel/preset-env": "^7.9.6",
-    "@babel/preset-react": "^7.9.4",
-    "@size-limit/preset-small-lib": "^4.4.5",
+    "@babel/cli": "^7.10.1",
+    "@babel/core": "^7.10.2",
+    "@babel/plugin-proposal-class-properties": "^7.10.1",
+    "@babel/plugin-transform-runtime": "^7.10.1",
+    "@babel/preset-env": "^7.10.2",
+    "@babel/preset-react": "^7.10.1",
+    "@size-limit/preset-small-lib": "^4.5.0",
     "babel-eslint": "^10.1.0",
     "babel-plugin-transform-require-extensions": "^2.0.1",
-    "babel-plugin-transform-runtime-file-extensions": "^1.0.0",
+    "babel-plugin-transform-runtime-file-extensions": "^2.0.0",
     "cross-fetch": "^3.0.4",
-    "eslint": "^6.8.0",
-    "eslint-config-env": "^13.0.6",
+    "eslint": "^7.2.0",
+    "eslint-config-env": "^14.0.3",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-jsdoc": "^24.0.1",
+    "eslint-plugin-import": "^2.21.1",
+    "eslint-plugin-jsdoc": "^27.0.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.1.3",
-    "eslint-plugin-react": "^7.19.0",
-    "eslint-plugin-react-hooks": "^4.0.0",
-    "fetch-blob": "^1.0.5",
-    "formdata-node": "^2.1.1",
-    "graphql": "^14.6.0",
-    "graphql-api-koa": "^4.1.2",
+    "eslint-plugin-react": "^7.20.0",
+    "eslint-plugin-react-hooks": "^4.0.4",
+    "fetch-blob": "^1.0.6",
+    "formdata-node": "^2.2.0",
+    "graphql": "^15.1.0",
+    "graphql-api-koa": "^6.0.0",
     "hard-rejection": "^2.1.0",
-    "jsdoc-md": "^6.0.0",
-    "koa": "^2.11.0",
+    "jsdoc-md": "^7.0.0",
+    "koa": "^2.12.0",
     "koa-bodyparser": "^4.3.0",
@@ -105,4 +105,4 @@ "prettier": "^2.0.5",
     "react-test-renderer": "^16.13.1",
-    "size-limit": "^4.4.5",
-    "test-director": "^4.0.0"
+    "size-limit": "^4.5.0",
+    "test-director": "^4.0.1"
   },
@@ -109,0 +109,0 @@ "scripts": {

readme.md

@@ -109,3 +109,3 @@ ![graphql-react logo](https://cdn.jsdelivr.net/gh/jaydenseric/graphql-react@0.1.0/graphql-react-logo.svg)
 
-- Node.js `10 - 12 || >= 13.7`
+- Node.js `^10.17.0 || ^12.0.0 || >= 13.7.0`
 - Browsers [`> 0.5%, not OperaMini all, not dead`](https://browserl.ist/?q=%3E+0.5%25%2C+not+OperaMini+all%2C+not+dead)
@@ -131,2 +131,6 @@
   - [GraphQL instance property operations](#graphql-instance-property-operations)
+  - [GraphQL event cache](#graphql-event-cache)
+  - [GraphQL event fetch](#graphql-event-fetch)
+  - [GraphQL event reload](#graphql-event-reload)
+  - [GraphQL event reset](#graphql-event-reset)
 - [function GraphQLProvider](#function-graphqlprovider)
@@ -207,5 +211,10 @@ - [function reportCacheErrors](#function-reportcacheerrors)
 
+##### Fires
+
+- [GraphQL event fetch](#graphql-event-fetch)
+- [GraphQL event cache](#graphql-event-cache)
+
 #### GraphQL instance method reload
 
-Signals that [GraphQL cache](#graphql-instance-property-cache) subscribers such as the [`useGraphQL`](#function-usegraphql) React hook should reload their GraphQL operation. Emits a [`GraphQL`](#class-graphql) instance `reload` event.
+Signals that [GraphQL cache](#graphql-instance-property-cache) subscribers such as the [`useGraphQL`](#function-usegraphql) React hook should reload their GraphQL operation.
 
@@ -216,2 +225,6 @@ | Parameter | Type | Description |
 
+##### Fires
+
+- [GraphQL event reload](#graphql-event-reload)
+
 ##### Examples
@@ -227,3 +240,3 @@
 
-Resets the [GraphQL cache](#graphql-instance-property-cache), useful when a user logs out. Emits a [`GraphQL`](#class-graphql) instance `reset` event.
+Resets the [GraphQL cache](#graphql-instance-property-cache), useful when a user logs out.
 
@@ -234,2 +247,6 @@ | Parameter | Type | Description |
 
+##### Fires
+
+- [GraphQL event reset](#graphql-event-reset)
+
 ##### Examples
@@ -277,2 +294,45 @@
 
+#### GraphQL event cache
+
+Signals that a GraphQL operation was fetched and cached.
+
+**Type:** object
+
+| Property | Type | Description |
+| :-- | :-- | :-- |
+| `cacheKey` | [GraphQLCacheKey](#type-graphqlcachekey) | The [GraphQL cache](#graphql-instance-property-cache) [key](#type-graphqlcachekey) for the operation that was cached. |
+| `cacheValue` | [GraphQLCacheValue](#type-graphqlcachevalue) | The loaded [GraphQL cache](#type-graphqlcache) [value](#type-graphqlcachevalue). |
+| `response` | Response? | The [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) instance; may be undefined if there was a fetch error. |
+
+#### GraphQL event fetch
+
+Signals that a GraphQL operation is being fetched.
+
+**Type:** object
+
+| Property | Type | Description |
+| :-- | :-- | :-- |
+| `cacheKey` | [GraphQLCacheKey](#type-graphqlcachekey) | The [GraphQL cache](#graphql-instance-property-cache) [key](#type-graphqlcachekey) for the operation being fetched. |
+| `cacheValuePromise` | Promise<[GraphQLCacheValue](#type-graphqlcachevalue)> | Resolves the loaded [GraphQL cache](#type-graphqlcache) [value](#type-graphqlcachevalue). |
+
+#### GraphQL event reload
+
+Signals that [GraphQL cache](#graphql-instance-property-cache) subscribers such as the [`useGraphQL`](#function-usegraphql) React hook should reload their GraphQL operation.
+
+**Type:** object
+
+| Property | Type | Description |
+| :-- | :-- | :-- |
+| `exceptCacheKey` | [GraphQLCacheKey](#type-graphqlcachekey)? | A [GraphQL cache](#graphql-instance-property-cache) [key](#type-graphqlcachekey) for cache to exempt from reloading. |
+
+#### GraphQL event reset
+
+Signals that the [GraphQL cache](#graphql-instance-property-cache) has been reset.
+
+**Type:** object
+
+| Property | Type | Description |
+| :-- | :-- | :-- |
+| `exceptCacheKey` | [GraphQLCacheKey](#type-graphqlcachekey)? | The [GraphQL cache](#graphql-instance-property-cache) [key](#type-graphqlcachekey) for cache that was exempted from deletion. |
+
 ---
@@ -316,9 +376,7 @@
 
-A [`GraphQL`](#class-graphql) `cache` event handler that reports [`fetch`](https://developer.mozilla.org/docs/Web/API/Fetch_API), HTTP, parse and GraphQL errors via `console.log()`. In a browser environment the grouped error details are expandable.
+A [`GraphQL` event `cache`](#graphql-event-cache) handler that reports [`fetch`](https://developer.mozilla.org/docs/Web/API/Fetch_API), HTTP, parse and GraphQL errors via `console.log()`. In a browser environment the grouped error details are expandable.
 
 | Parameter | Type | Description |
 | :-- | :-- | :-- |
-| `data` | object | [`GraphQL`](#class-graphql) `cache` event data. |
-| `data.cacheKey` | [GraphQLCacheKey](#type-graphqlcachekey) | [GraphQL cache](#graphql-instance-property-cache) [key](#type-graphqlcachekey). |
-| `data.cacheValue` | [GraphQLCacheKey](#type-graphqlcachekey) | [GraphQL cache](#graphql-instance-property-cache) [value](#type-graphqlcachevalue). |
+| `data` | [GraphQL#event:cache](#graphql-event-cache) | [`GraphQL`](#class-graphql) `cache` event data. |
 
@@ -325,0 +383,0 @@ #### Examples

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

81532

increased by3.14%

Number of lines in readme file

854

increased by7.29%

Number of medium supply chain risk alerts

2

decreased by-33.33%

Dependency changes

• Updated@babel/runtime@^7.10.2