Git Product home page Git Product logo

cat-session's Introduction

Cat Session ๐Ÿˆ for Redux

Session manager, actions and reducers for Redux/Immutable.

๐Ÿฑ Installation

npm install -s cat-session

๐Ÿฑ Configuration

Define custom fields for the session

const sessionDataFields = { 
  displayName: '',
  username: '',
  id: null,
  profileImage: null,
  email: null
}

Add session actions:

import { createSessionActions } from 'cat-session';

const sessionActions = createSessionActions({
  dataFields: sessionDataFields,
  serverUrl: endpoint
  // urls: {} - you can define custom paths for the requests
});

Add session reducers:

import { createSessionStore } from 'cat-session'

const stores = {
  session: createSessionStore(sessionDataFields),
  ...myOtherStores
}

๐Ÿฑ Usage

Actions

  • init() - call it right after your app is started, the session values will be loaded from localStorage (or AsyncStorage for React Native)
  • logIn(data) - POST request to ${serverUrl}login or urls.login
  • logOff() - log off
  • register(data) - POST request to ${serverUrl}register or urls.register
  • updateProfile(data) - PUT request to ${serverUrl}profile or urls.profile
  • uploadProfileImage(image) - POST request to ${serverUrl}upload/image or urls.upload, uploaded as form/multipart
  • locate(coords) - PUT request to ${serverUrl}locate or urls.locate, should be called on user position change
  • resetIsJustRegistered() - reset isJustRegistered

Store fields (all the fields are Immutable values!)

  • initializing - true if session data in not available yet
  • loggedIn - true if user is logged in
  • loggingIn - true if user is logging in or registering
  • token - session JWT
  • uploadProgress - profile image upload progress in percent
  • isUploadingProfileImage - true during profile image upload
  • isJustRegistered - true after registration completed, could be reseted by calling resetIsJustRegistered()
  • error - text value with login/registration error ('loginErrorUnauthorized', 'loginErrorForbidden', 'loginError')
  • ALL THE FIELDS FROM sessionDataFields

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.