Merge pull request #210 from agraboso/next

Release 3.0

Author: nason

.babelrc

@@ -1,17 +1,19 @@
 {
-  "parser": "babel-eslint",
   "plugins": [
-    "babel",
-    "prettier"
+    "prettier",
+    "jest"
   ],
+  "extends": ["plugin:jest/recommended"],
   "env": {
     "browser": true,
-    "es6": true
+    "es6": true,
+    "jest/globals": true
   },
   "parserOptions": {
+    "ecmaVersion": 2017,
+    "sourceType": "module",
     "ecmaFeatures": {
-      "experimentalObjectRestSpread": true,
-      "modules": true
+      "experimentalObjectRestSpread": true
     }
   },
   "root": true,

.eslintrc

@@ -1,5 +1,8 @@
 node_modules
 *.log
 lib
+es
 coverage
+.nyc_output
 .idea
+.DS_Store

.gitignore

@@ -0,0 +1,24 @@
+[
+  {
+    "name": "lib/index.cjs.js (min)",
+    "path": "lib/index.cjs.js",
+    "limit": "10 KB",
+    "gzip": false
+  },
+  {
+    "name": "lib/index.cjs.js (min + gzip)",
+    "path": "lib/index.cjs.js",
+    "limit": "4 KB"
+  },
+  {
+    "name": "lib/index.umd.js (min)",
+    "path": "lib/index.umd.js",
+    "limit": "30 KB",
+    "gzip": false
+  },
+  {
+    "name": "lib/index.umd.js (min + gzip)",
+    "path": "lib/index.umd.js",
+    "limit": "12 KB"
+  }
+]

.size-limit

@@ -2,7 +2,6 @@ language: node_js
 node_js:
   - "node"
   - "lts/*"
-  - "6"
 cache:
   directories:
     - "node_modules"

.travis.yml

@@ -0,0 +1,17 @@
+## Prerequisites
+
+[Node.js](http://nodejs.org/) >= v8 must be installed.
+
+## Installation
+
+- Running `npm install` in the module's root directory will install everything you need for development.
+
+## Running Tests
+
+- `npm test` will run the tests once.
+
+## Building
+
+- `npm run build` will build the module.
+
+- `npm run clean` will delete built resources.

CONTRIBUTING.md

@@ -26,6 +26,7 @@ See the changes in the [beta's documentation](https://github.com/agraboso/redux-
 
 - [Introduction](#introduction)
   - [Breaking Changes in 2.0 Release](#breaking-changes-in-20-release)
+  - [Breaking Changes in 3.0 Release](#breaking-changes-in-30-release)
 - [Installation](#installation)
     - [configureStore.js](#configurestorejs)
     - [app.js](#appjs)
@@ -50,6 +51,7 @@ See the changes in the [beta's documentation](https://github.com/agraboso/redux-
   - [Exports](#exports)
     - [`RSAA`](#rsaa)
     - [`apiMiddleware`](#apimiddleware)
+    - [`createMiddleware(options)`](#createmiddlewareoptions)
     - [`isRSAA(action)`](#isrsaaaction)
     - [`validateRSAA(action)`](#validatersaaaction)
     - [`isValidRSAA(action)`](#isvalidrsaaaction)
@@ -73,11 +75,13 @@ See the changes in the [beta's documentation](https://github.com/agraboso/redux-
     - [`[RSAA].credentials`](#rsaacredentials-1)
     - [`[RSAA].bailout`](#rsaabailout)
     - [`[RSAA].fetch`](#rsaafetch-1)
+    - [`[RSAA].ok`](#rsaaok)
     - [`[RSAA].types`](#rsaatypes)
     - [Type descriptors](#type-descriptors)
 - [History](#history)
 - [Tests](#tests)
 - [Upgrading from v1.0.x](#upgrading-from-v10x)
+- [Upgrading from v2.0.x](#upgrading-from-v20x)
 - [License](#license)
 - [Projects using redux-api-middleware](#projects-using-redux-api-middleware)
 - [Acknowledgements](#acknowledgements)
@@ -142,6 +146,10 @@ We have tiptoed around error-handling issues here. For a thorough walkthrough of
 
 See the [2.0 Release Notes](https://github.com/agraboso/redux-api-middleware/releases/tag/v2.0.0), and [Upgrading from v1.0.x](#upgrading-from-v10x) for details on upgrading.
 
+### Breaking Changes in 3.0 Release
+
+See the [3.0 Release Notes](https://github.com/agraboso/redux-api-middleware/releases/tag/v3.0.0), and [Upgrading from v2.0.x](#upgrading-from-v20x) for details on upgrading.
+
 ## Installation
 
 `redux-api-middleware` is available on [npm](https://www.npmjs.com/package/redux-api-middleware).
@@ -370,8 +378,8 @@ The `[RSAA].types` property controls the output of `redux-api-middleware`. The s
   - `fetch` may throw an error: the RSAA definition is not strong enough to preclude that from happening (you may, for example, send in a `[RSAA].body` that is not valid according to the fetch specification — mind the SHOULDs in the [RSAA definition](#redux-standard-api-calling-actions));
   - a network failure occurs (the network is unreachable, the server responds with an error,...).
 
-  If such an error occurs, a different *request* FSA will be dispatched (*instead* of the one described above). It will contain the following properties:
-  - `type`: the string constant in the first position of the `[RSAA].types` array;
+  If such an error occurs, a *failure* FSA will be dispatched containing the following properties:
+  - `type`: the string constant in the last position of the `[RSAA].types` array;
   - `payload`: a [`RequestError`](#requesterror) object containing an error message;
   - `error: true`.
 
@@ -409,7 +417,7 @@ See [the Redux docs on composition](https://github.com/reduxjs/redux-thunk#compo
 export function patchAsyncExampleThunkChainedActionCreator(values) {
   return async(dispatch, getState) => {
     const actionResponse = await dispatch({
-      [CALL_API]: {
+      [RSAA]: {
         endpoint: "...",
         method: "PATCH",
         body: JSON.stringify(values),
@@ -670,6 +678,7 @@ For example, if you want the status code and status message of a unsuccessful AP
   }
 }
 ```
+
 By default, *failure* FSAs will not contain a `meta` property, while their `payload` property will be evaluated from
 ```js
 (action, state, res) =>
@@ -678,6 +687,9 @@ By default, *failure* FSAs will not contain a `meta` property, while their `payl
   )
 ```
 
+
+Note that *failure* FSAs dispatched due to fetch errors will not have a `res` argument into `meta` or `payload`. The `res` parameter will exist for completed requests that have resulted in errors, but not for failed requests.
+
 ### Exports
 
 The following objects are exported by `redux-api-middleware`.
@@ -690,6 +702,15 @@ A JavaScript `String` whose presence as a key in an action signals that `redux-a
 
 The Redux middleware itself.
 
+#### `createMiddleware(options)`
+
+A function that creates an `apiMiddleware` with custom options.
+
+The following `options` properties are used:
+
+- `fetch` - provide a `fetch` API compatible function here to use instead of the default `window.fetch`
+- `ok` - provide a function here to use as a status check in the RSAA flow instead of `(res) => res.ok`
+
 #### `isRSAA(action)`
 
 A function that returns `true` if `action` has an `[RSAA]` property, and `false` otherwise.
@@ -802,9 +823,9 @@ A *Redux Standard API-calling Action* MUST
 - be a plain JavaScript object,
 - have an `[RSAA]` property.
 
-A *Redux Standard API-calling Action* MUST NOT
+A *Redux Standard API-calling Action* MAY
 
-- include properties other than `[RSAA]`.
+- include properties other than `[RSAA]` (but will be ignored by redux-api-middleware).
 
 #### `[RSAA]`
 
@@ -822,11 +843,12 @@ The `[RSAA]` property MAY
 - have an `options` property,
 - have a `credentials` property,
 - have a `bailout` property,
-- have a `fetch` property.
+- have a `fetch` property,
+- have an `ok` property.
 
 The `[RSAA]` property MUST NOT
 
-- include properties other than `endpoint`, `method`, `types`, `body`, `headers`, `options`, `credentials`, `bailout` and `fetch`.
+- include properties other than `endpoint`, `method`, `types`, `body`, `headers`, `options`, `credentials`, `bailout`, `fetch` and `ok`.
 
 #### `[RSAA].endpoint`
 
@@ -860,7 +882,11 @@ The optional `[RSAA].bailout` property MUST be a boolean or a function.
 
 #### `[RSAA].fetch`
 
-The optional `[RSAA].fetch` property MUST be a function.
+The optional `[RSAA].fetch` property MUST be a function that conforms to the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
+
+#### `[RSAA].ok`
+
+The optional `[RSAA].ok` property MUST be a function that accepts a response object and returns a boolean indicating if the request is a success or failure
 
 #### `[RSAA].types`
 
@@ -899,6 +925,13 @@ $ npm install && npm test
 - A new `options` config is added to pass your `fetch` implementation extra options other than `method`, `headers`, `body` and `credentials`
 - `apiMiddleware` no longer returns a promise on actions without [RSAA]
 
+## Upgrading from v2.0.x
+
+- The `CALL_API` alias has been removed
+- Error handling around failed fetches has been updated (#175)
+  - Previously, a failed `fetch` would dispatch a `REQUEST` FSA followed by another `REQUEST` FSA with an error flag
+  - Now, a failed `fetch` will dispatch a `REQUEST` FSA followed by a `FAILURE` FSA
+
 ## License
 
 MIT

README.md

@@ -0,0 +1,25 @@
+module.exports = function (api) {
+  const env = api.cache(() => process.env.NODE_ENV);
+
+  const nodeTarget = env === 'test' ? 'current' : '8';
+  const envModules = env === 'test' ? 'commonjs' : false;
+
+  const presets = [
+    [
+      "@babel/preset-env", {
+        modules: envModules,
+        "useBuiltIns": "usage",
+        "targets": {
+          "node": nodeTarget
+        },
+      }
+    ]
+  ];
+
+  const plugins = [];
+
+  return {
+    presets,
+    plugins
+  };
+}

babel.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  verbose: !!process.env.CI,
+  automock: false,
+  resetMocks: true,
+  restoreMocks: true,
+  resetModules: true,
+  setupFiles: [
+    "./test/setupJest.js"
+  ],
+  moduleNameMapper: {
+    "^redux-api-middleware$": process.env.TEST_LIB ? '..' : './index'
+  }
+};