Add flashMessageType for propType checking (#8)

* Add flashMessageType

* Update readme

* v1.2.0

README.md

@@ -83,6 +83,8 @@ Message objects returned by these selectors will have the following format:
 }
 ```
 
+A [PropType](https://github.com/facebook/prop-types) for this object is exported from this module as `flashMessageType`.
+
 ### Reducer
 
 `redux-flash` exposes a reducer to handle the actions it creates. This reducer must be attached to your root reducer using the key `flash` in order for the library to function (see [example](#example)).
@@ -96,7 +98,7 @@ Message objects returned by these selectors will have the following format:
 import React from 'react'
 import PropTypes from 'prop-types'
 import { connect } from 'react-redux'
-import { getLatestMessage } from 'redux-flash'
+import { getLatestMessage, flashMessageType } from 'redux-flash'
 
 function FlashMessages ({ flash }) {
     return (
@@ -109,9 +111,7 @@ function FlashMessages ({ flash }) {
 }
 
 FlashMessages.propTypes = {
-    flash: PropTypes.shape({
-        message: PropTypes.string.isRequired
-    })
+    flash: flashMessageType
 }
 
 function mapStateToProps (state) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-flash",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Redux action creators for displaying flash messages",
   "main": "lib/index.js",
   "scripts": {
@@ -43,6 +43,7 @@
     "rimraf": "^2.5.4"
   },
   "dependencies": {
+    "prop-types": "^15.6.1",
     "redux-actions": "^2.0.3",
     "uuid": "^3.1.0"
   },

src/flashMessageType.js

@@ -0,0 +1,10 @@
+import PropTypes from 'prop-types'
+
+const flashMessageType = PropTypes.shape({
+  id: PropTypes.string.isRequired,
+  message: PropTypes.string.isRequired,
+  isError: PropTypes.bool.isRequired,
+  props: PropTypes.object.isRequired,
+})
+
+export default flashMessageType

src/index.js

@@ -5,10 +5,11 @@ export {
   clearMessages,
   removeMessage,
 } from './actions'
+export flashMessageType from './flashMessageType'
 export {
   reducer,
   getFlashMessages,
   getSuccessMessages,
   getErrorMessages,
   getLatestMessage,
-} from './reducer'
+} from './reducer'

test/actions.test.js

@@ -2,7 +2,7 @@ import {
   flashMessage,
   flashErrorMessage,
 } from '../src'
-import configureStore from './mock-store'
+import configureStore from './mockStore'
 import thunkMiddleware from 'redux-thunk'
 
 const mockStore = configureStore([ thunkMiddleware ])

test/flashMessageType.test.js

@@ -0,0 +1,24 @@
+import PropTypes from 'prop-types'
+import {
+  flashMessage,
+  flashMessageType,
+} from '../src'
+import configureStore from './mockStore'
+import thunkMiddleware from 'redux-thunk'
+
+const mockStore = configureStore([ thunkMiddleware ])
+
+function validatePropType (propType, value) {
+  // checkPropTypes will log an error if it fails
+  const spy = jest.spyOn(console, 'error')
+  PropTypes.checkPropTypes({ value: propType }, { value }, 'prop')
+  expect(spy).not.toHaveBeenCalled()
+}
+
+test('propTypes match flash message object shape', () => {
+  const store = mockStore({})
+  store.dispatch(flashMessage('Hi'))
+  // Get generated flash message
+  const messageObject = store.getActions().pop().payload
+  return validatePropType(flashMessageType, messageObject)
+})