redux-react-session-immutable v1.0.1

Redux React Immutable Session

An immutablejs wrapper around Redux React Session

Keep your session sync with localStorage and Redux :key:

Redux React Session provides an API that allows to manage sessions through the app, with authorization function for react-router and a persisted session.

Installation

npm install redux-react-session-immutable --save

Usage

• Add the session reducer:

import { combineReducers } from 'redux';
import { sessionReducer } from 'redux-react-session';

const reducers = {
  // ... your other reducers here ...
  session: sessionReducer
};
const reducer = combineReducers(reducers);

• Initiate the session service:

import { createStore } from 'redux';
import { sessionService } from 'redux-react-session';

const store = createStore(reducer)

sessionService.initSessionService(store);

Example

The example simulates a simple login/logut that sends requests to a server.

Run the example

1. get into the folder:cd example
2. install dependencies: npm install
3. run the example: npm start

API

initSessionService(store, refreshOnCheckAuth:Boolean, redirectPath:String)

Initialize a singleton instance of the session service.

Options:

• store: Mandatory option, is used to keep sync the localStorage with Redux store
• refreshOnCheckAuth(default: false): Refresh Redux store in the checkAuth function
• redirectPath(default: "login"): Path used when a session is rejected or doesn't exist

refreshFromLocalStorage

Force to refresh the Redux Store from the localStorage.

Note: this function is called once the session service is initialized

checkAuth

Authorization function for react-router to restrict routes, it checks if exist a session and redirects to the redirectPath

Example:

import React from 'react';
import { Route, IndexRoute } from 'react-router';
import { sessionService } from 'redux-react-session';
import App from './components/App';
import HomePage from './containers/HomePage';
import LoginPage from './containers/LoginPage';

export default (
  <Route path="/" component={App}>
    <IndexRoute onEnter={sessionService.checkAuth} component={HomePage} />
    <Route path="login" component={LoginPage} />
  </Route>
);

saveSession(session:object) : Promise

Saves the session object in the localStorage and changes the authenticated flag to true in Redux Store

loadSession : Promise(currentSession:Object)

Returns the current session if exists

Example:

loadSession
.then(currentSession => console.log(currentSession))
.catch(err => console.log(err))

deleteSession : Promise

Deletes the current session

saveUser(user:object) : Promise

Saves the user object in the localStorage and in the Redux Store

loadUser : Promise

Returns the current user if exists

deleteUser : Promise

Deletes the current user