More api features

README.md

@@ -111,6 +111,10 @@ True if Flagsmith has been configured to use a specific identity when resolving
 
 See [identify](#identify) for more information.
 
+### isListening: *boolean*
+
+True if Flagsmith is configured to listen for updates. See [startListening](#startListening) for more details.
+
 ### isError: *boolean*
 
 True if the Flagsmith integration is in an errored state (e.g. the server could not be reached). False otherwise.
@@ -121,7 +125,15 @@ True if the Flagsmith integration is in an errored state (e.g. the server could
 await identify(identity)
 ```
 
-Passes the supplied identity to the Flagsmith backend to be used when resolving feature flags and remote configuration. This causes an update in the state, which is an async action. Use the [isIdentified](isIdentified) flag to determine when the state has been re-loaded.
+Passes the supplied identity to the Flagsmith backend to be used when resolving feature flags and remote configuration. This causes an update in the state, which is an async action. Use the [isIdentified](#isIdentified) flag to determine when the state has been re-loaded, or use [subscribe](#subscribe) to receive an update notification.
+
+### logout
+
+```javascript
+await logout()
+```
+
+Remove any identifty associated with the Flagsmith client. Use the [isIdentified](#isIdentified) flag to determine when the state has been re-loaded, or use [subscribe](#subscribe) to receive an update notification.
 
 ### hasFeature
 
@@ -133,13 +145,31 @@ Determines is the feature specified `key` is set or not.
 
 ### getValue
 
-```
+```javascript
 getValue(key)
 ```
 
 Gets the current value of the remote configuration item specified by the `key`.
 
-### subscribe(callback)
+### startListening
+
+```javascript
+startListening(interval = 1000)
+```
+Begin listening for backend configuration changes. The polling interval is specified in mS. Use [isListening](#isListening) to determine the current listening state, and [subscribe](#subscribe) to be notified of updates.
+
+### stopListeing
+
+```javascript
+stopListening()
+```
+Stop listening (polling) for configuration changes.
+
+### subscribe
+
+```javascript
+subscribe(callback)
+```
 
 Registers a callback with Flagsmith that will be triggered any time a new configuration is available, for example after loading is complete, or when a new user is identified. This can be used to update any configuration state in components using Flagsmith, per the following example.
 

__tests__/reducer.test.js

@@ -4,7 +4,8 @@ import { reducer } from '../src/reducer'
 const initialState = {
   isLoading: true,
   isError: false, 
-  isIdentified: false
+  isIdentified: false,
+  isListening: false
 }
 
 describe('reducer', () => {
@@ -32,6 +33,18 @@ describe('reducer', () => {
     expect(newState).toEqual({...initialState, isLoading: false, isIdentified: false})
   })
 
+  test('can listen', () =>{
+    const newState = reducer({...initialState}, {type: 'START_LISTENING'})
+
+    expect(newState).toEqual({...initialState, isListening: true})
+  })
+
+  test('can stop listening', () => {
+    const newState = reducer({...initialState, isListening: true}, {type: 'STOP_LISTENING'})
+
+    expect(newState).toEqual({...initialState, isListening: false})
+  })
+
   test('can be errored', () => {
     const newState = reducer({...initialState}, {type: 'ERRORED'})
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-react",
-  "version": "0.0.3-alpha.1",
+  "version": "0.0.4-alpha.1",
   "preview": true,
   "description": "Flagsmith integration for React Single Page Applications (SPA)",
   "repository": {

src/flagsmith-provider.js

@@ -10,7 +10,7 @@ import { useEventEmitter } from './use-event-emitter'
 
 const FlagsmithProvider = ({ environmentId, children }) => {
 
-  const [state, dispatch] = useReducer(reducer, { isLoading: true, isError: false, isIdentified: false })
+  const [state, dispatch] = useReducer(reducer, { isLoading: true, isError: false, isIdentified: false, isListening: false })
   const { emit, useSubscription } = useEventEmitter()
 
   const handleChange = useCallback(e => emit(e), [emit])
@@ -41,6 +41,30 @@ const FlagsmithProvider = ({ environmentId, children }) => {
     }, []
   )
 
+  const logout = useCallback(
+    async () => {
+      try {
+        await flagsmith.logout()
+      } finally {
+        dispatch({type: 'UNIDENTIFIED'})  
+      }
+    }, []
+  )
+
+  const startListening = useCallback(
+    (interval = 1000) => {
+      flagsmith.startListening(interval)
+      dispatch({type: 'START_LISTENING'})
+    }, []
+  )
+
+  const stopListening = useCallback(
+    () => {
+      flagsmith.stopListening()
+      dispatch({type: 'STOP_LISTENING'})
+    }, []
+  )
+
   const hasFeature = useCallback(
     (key) => {
       return flagsmith.hasFeature(key)
@@ -54,7 +78,15 @@ const FlagsmithProvider = ({ environmentId, children }) => {
   )
 
   return (
-    <FlagsmithContext.Provider value={{...state, identify, hasFeature, getValue, subscribe: useSubscription}}>
+    <FlagsmithContext.Provider value={{
+      ...state, 
+      identify, 
+      hasFeature, 
+      getValue, 
+      subscribe: useSubscription, 
+      logout,
+      startListening,
+      stopListening}}>
       {children}
     </FlagsmithContext.Provider>
   )

src/reducer.js

@@ -12,6 +12,12 @@ export const reducer = (state, action) => {
     case 'ERRORED': {
       return {...state, isLoading: false, isError: true}
     }
+    case 'START_LISTENING': {
+      return {...state, isListening: true}
+    }
+    case 'STOP_LISTENING': {  
+      return {...state, isListening: false}
+    }
     default: {
       return {...state}
     }