Routine maintenance 2023-07 (#158)

* Large package updates

* Run yarn upgrade

* Bump major

* Update axios dev dependency

* Do not use undeclared dependency

* Remove axios as dev dependency (unneeded)

* Add husky

* Update yarn.lock

* Add GH action

Author: chawes13

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+run-name: ${{ github.actor }} published a new release
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out latest code
+        uses: actions/checkout@v3
+      - name: Set up node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@launchpadlab'
+      - name: Install dependencies
+        run: HUSKY=0 yarn --frozen-lockfile
+      - name: Publish package on NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn run docs && git add docs.md

.nvmrc

@@ -0,0 +1 @@
+18

.travis.yml

@@ -1,6 +1,7 @@
 language: node_js
+dist: focal
 node_js:
-- '8'
+- '18'
 before_script:
   - 'yarn lint'
 notifications:

docs.md

@@ -2,45 +2,45 @@
 
 ### Table of Contents
 
--   [handleSuccess][1]
-    -   [Parameters][2]
-    -   [Examples][3]
--   [handleFailure][4]
-    -   [Parameters][5]
-    -   [Examples][6]
--   [handleResponse][7]
-    -   [Parameters][8]
-    -   [Examples][9]
--   [setOnSuccess][10]
-    -   [Parameters][11]
-    -   [Examples][12]
--   [setOnFailure][13]
-    -   [Parameters][14]
-    -   [Examples][15]
--   [setOnResponse][16]
-    -   [Parameters][17]
-    -   [Examples][18]
--   [LP_API][19]
-    -   [Examples][20]
--   [createRequest][21]
-    -   [Parameters][22]
-    -   [Examples][23]
--   [middleware][24]
--   [reducer][25]
-    -   [Examples][26]
--   [selectors][27]
-    -   [Examples][28]
--   [createStubRequest][29]
-    -   [Parameters][30]
-    -   [Examples][31]
+*   [handleSuccess][1]
+    *   [Parameters][2]
+    *   [Examples][3]
+*   [handleFailure][4]
+    *   [Parameters][5]
+    *   [Examples][6]
+*   [handleResponse][7]
+    *   [Parameters][8]
+    *   [Examples][9]
+*   [setOnSuccess][10]
+    *   [Parameters][11]
+    *   [Examples][12]
+*   [setOnFailure][13]
+    *   [Parameters][14]
+    *   [Examples][15]
+*   [setOnResponse][16]
+    *   [Parameters][17]
+    *   [Examples][18]
+*   [LP\_API][19]
+    *   [Examples][20]
+*   [createRequest][21]
+    *   [Parameters][22]
+    *   [Examples][23]
+*   [middleware][24]
+*   [reducer][25]
+    *   [Examples][26]
+*   [selectors][27]
+    *   [Examples][28]
+*   [createStubRequest][29]
+    *   [Parameters][30]
+    *   [Examples][31]
 
 ## handleSuccess
 
 A function that takes an API action handler and only applies that handler when the request succeeds.
 
 ### Parameters
 
--   `handler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
+*   `handler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
 
 ### Examples
 
@@ -61,7 +61,7 @@ A function that takes an API action handler and only applies that handler when t
 
 ### Parameters
 
--   `handler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
+*   `handler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
 
 ### Examples
 
@@ -83,8 +83,8 @@ and applies the handlers when the responses have the correct status.
 
 ### Parameters
 
--   `successHandler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
--   `failureHandler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
+*   `successHandler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
+*   `failureHandler` **[Function][32]** An action handler that is passed `state`, `action` and `data` params
 
 ### Examples
 
@@ -111,8 +111,8 @@ A function that creates an API action handler that sets a path in the state with
 
 ### Parameters
 
--   `path` **[String][33]** The path in the state to set with the returned data
--   `transform` **[Function][32]?** A function that determines the data that is set in the state. Passed `action` and `state` params.
+*   `path` **[String][33]** The path in the state to set with the returned data
+*   `transform` **[Function][32]?** A function that determines the data that is set in the state. Passed `action` and `state` params.
 
 ### Examples
 
@@ -131,8 +131,8 @@ A function that creates an API action handler that sets a path in the state with
 
 ### Parameters
 
--   `path` **[String][33]** The path in the state to set with the returned error
--   `transform` **[Function][32]?** A function that determines the data that is set in the state. Passed `action` and `state` params.
+*   `path` **[String][33]** The path in the state to set with the returned error
+*   `transform` **[Function][32]?** A function that determines the data that is set in the state. Passed `action` and `state` params.
 
 ### Examples
 
@@ -151,10 +151,10 @@ A function that creates an API action handler that sets one of two given paths i
 
 ### Parameters
 
--   `path` **[String][33]** The path in the state to set with the returned data on success
--   `path` **[String][33]** The path in the state to set with the returned error on failure
--   `transform` **[Function][32]?** A function that determines the success data that is set in the state. Passed `action` and `state` params.
--   `transform` **[Function][32]?** A function that determines the error data that is set in the state. Passed `action` and `state` params.
+*   `path` **[String][33]** The path in the state to set with the returned data on success
+*   `path` **[String][33]** The path in the state to set with the returned error on failure
+*   `transform` **[Function][32]?** A function that determines the success data that is set in the state. Passed `action` and `state` params.
+*   `transform` **[Function][32]?** A function that determines the error data that is set in the state. Passed `action` and `state` params.
 
 ### Examples
 
@@ -167,7 +167,7 @@ handleActions({
 
 Returns **[Function][32]** An action handler
 
-## LP_API
+## LP\_API
 
 A unique key that identifies dispatched actions to be handled by the LP
 Redux Api middleware. This is implemented as a Symbol, instead of a String
@@ -186,8 +186,8 @@ function fooAction () {
   return {
     [LP_API]: {
       url: 'http://foo.com/posts',
-      requestAction: 'REQUEST', 
-      successAction: 'SUCCESS', 
+      requestAction: 'REQUEST',
+      successAction: 'SUCCESS',
       failureAction: 'FAILURE',
     }
   }
@@ -202,8 +202,8 @@ Note: there are convenience functions for each request method: `createPostReques
 
 ### Parameters
 
--   `type` **[String][33]** A unique key that will be used to identify the request internally in redux
--   `definition` **([Object][36] \| [Function][32])** An object of config options for the adapter, or a function that returns config options.
+*   `type` **[String][33]** A unique key that will be used to identify the request internally in redux
+*   `definition` **([Object][36] | [Function][32])** An object of config options for the adapter, or a function that returns config options.
 
 ### Examples
 
@@ -243,11 +243,11 @@ The `adapter` argument is the function that will be invoked to make the API requ
 
 The following options may be used to configure the middleware:
 
--   `onUnauthorized` (default=`null`): An action creator to be called and dispatched when the server rejects a request with a status of `unauthorized`.
--   `requestAction` (default=`null`): An action creator to be called and dispatched when the initial request is made.
--   `successAction` (default=`null`): An action creator to be called and dispatched if the request succeeds.
--   `failureAction` (default=`null`): An action creator to be called and dispatched if the request fails.
--   any options used by the adapter
+*   `onUnauthorized` (default=`null`): An action creator to be called and dispatched when the server rejects a request with a status of `unauthorized`.
+*   `requestAction` (default=`null`): An action creator to be called and dispatched when the initial request is made.
+*   `successAction` (default=`null`): An action creator to be called and dispatched if the request succeeds.
+*   `failureAction` (default=`null`): An action creator to be called and dispatched if the request fails.
+*   any options used by the adapter
 
 ## reducer
 
@@ -286,22 +286,22 @@ selectStatus(REQ_FETCH_USERS, state) // -> 'loading'
 
 This library exports the following selectors for determining the status of requests:
 
--   `selectors.status(state, requestAction, [slice])`
--   `selectors.hasStatus(state, requestAction, [slice])`
--   `selectors.isLoading(state, requestAction, [slice])`
--   `selectors.isComplete(state, requestAction, [slice])`
--   `selectors.isSuccess(state, requestAction, [slice])`
--   `selectors.isFailure(state, requestAction, [slice])`
+*   `selectors.status(state, requestAction, [slice])`
+*   `selectors.hasStatus(state, requestAction, [slice])`
+*   `selectors.isLoading(state, requestAction, [slice])`
+*   `selectors.isComplete(state, requestAction, [slice])`
+*   `selectors.isSuccess(state, requestAction, [slice])`
+*   `selectors.isFailure(state, requestAction, [slice])`
 
 In order to work, the `lp-redux-api` reducer must be included in `combineReducers()`.
 Selectors expect the reducer to be keyed under `'api'`- if a different key is used,
 it must be passed as the optional `slice` parameter.
 
 The status returned by `selectors.status()` can be one of the following exported constants:
 
--   `LP_API_STATUS_LOADING`: `'loading'`
--   `LP_API_STATUS_SUCCESS`: `'success'`
--   `LP_API_STATUS_FAILURE`: `'failure'`
+*   `LP_API_STATUS_LOADING`: `'loading'`
+*   `LP_API_STATUS_SUCCESS`: `'success'`
+*   `LP_API_STATUS_FAILURE`: `'failure'`
 
 ### Examples
 
@@ -336,10 +336,11 @@ If an exception is thrown from the data creator function, the "request" will rej
 
 ### Parameters
 
--   `type` **[String][33]** A unique key that will be used to identify the request internally in redux
--   `dataDefinition` **([Object][36] \| [Function][32])** Data that the request will resolve with, or a function that returns data to resolve with.
--   `options` **[Object][36]?** Options object
-    -   `options.delay` **[Number][39]** Time (in ms) to delay the API request. Particularly useful when attempting to simulate loading states. (optional, default `0`)
+*   `type` **[String][33]** A unique key that will be used to identify the request internally in redux
+*   `dataDefinition` **([Object][36] | [Function][32])** Data that the request will resolve with, or a function that returns data to resolve with.
+*   `options` **[Object][36]?** Options object
+
+    *   `options.delay` **[Number][39]** Time (in ms) to delay the API request. Particularly useful when attempting to simulate loading states. (optional, default `0`)
 
 ### Examples
 

package.json

@@ -1,17 +1,16 @@
 {
   "name": "@launchpadlab/lp-redux-api",
-  "version": "6.3.1",
+  "version": "7.0.0",
   "description": "redux middleware and api library",
   "main": "lib/index.js",
   "scripts": {
     "start": "yarn install && yarn run build:development",
     "build": "mkdir -p lib && babel src --out-dir lib --no-comments --minified",
     "build:development": "mkdir -p lib && babel src --watch --out-dir lib",
-    "clean": "rimraf lib",
+    "clean": "rm -rf lib",
     "docs": "documentation build src/index.js -f md -o docs.md",
     "lint": "eslint src",
-    "precommit": "yarn run docs && git add docs.md",
-    "prepublish": "yarn run lint && yarn run clean && yarn run build",
+    "prepare": "yarn run lint && yarn run clean && yarn run build && husky install",
     "test": "jest",
     "test:coverage": "jest --coverage",
     "report-coverage": "codeclimate-test-reporter < coverage/lcov.info"
@@ -36,22 +35,20 @@
     "lib/"
   ],
   "devDependencies": {
-    "@babel/cli": "^7.5.5",
-    "@babel/core": "^7.5.5",
-    "@launchpadlab/babel-preset": "^2.1.0",
-    "@launchpadlab/eslint-config": "^2.4.1",
-    "axios": "^0.18.0",
-    "codeclimate-test-reporter": "^0.5.0",
-    "documentation": "^12.1.1",
-    "eslint": "^6.2.1",
-    "husky": "^3.0.4",
-    "jest": "^24.9.0",
-    "redux": "^4.0.4",
-    "redux-mock-store": "^1.2.3"
+    "@babel/cli": "^7.22.9",
+    "@babel/core": "^7.22.9",
+    "@launchpadlab/babel-preset": "^2.1.1",
+    "@launchpadlab/eslint-config": "^3.0.1",
+    "codeclimate-test-reporter": "^0.5.1",
+    "documentation": "^14.0.2",
+    "eslint": "^8.46.0",
+    "husky": "^8.0.0",
+    "jest": "^29.6.2",
+    "redux": "^4.2.1",
+    "redux-mock-store": "^1.5.4"
   },
   "dependencies": {
-    "es6-symbol": "^3.1.1",
-    "lodash": "^4.17.4",
+    "lodash": "^4.17.21",
     "util-deprecate": "^1.0.2"
   }
 }

src/LP_API.js

@@ -1,29 +1,27 @@
-import Symbol from 'es6-symbol'
-
 /**
  * A unique key that identifies dispatched actions to be handled by the LP
  * Redux Api middleware. This is implemented as a Symbol, instead of a String
  * to guarantee uniqueness.
- * 
+ *
  * The params provided as the value include anything that is supported by
  * {@link middleware|LP Redux Api Middleware}
- * 
+ *
  * @constant
  * @type {Symbol}
  * @default
  * @example
- * 
+ *
  * // An example action creator
  * function fooAction () {
  *   return {
  *     [LP_API]: {
  *       url: 'http://foo.com/posts',
- *       requestAction: 'REQUEST', 
- *       successAction: 'SUCCESS', 
+ *       requestAction: 'REQUEST',
+ *       successAction: 'SUCCESS',
  *       failureAction: 'FAILURE',
  *     }
  *   }
- * } 
+ * }
  */
 
 const LP_API = Symbol('Lp Api')