Lib for auth

Content

• Action creators:
  • for auth: signIn, signUp, forgotPassword, restorePassword, logout, refreshToken
  • for oauth: getTwitterAuthUrl, complete
• Action types:
  • for auth: SIGN_IN, SIGN_UP, FORGOT_PASSWORD, RESTORE_PASSWORD, LOGOUT, REFRESH_TOKEN,
  • for oauth: PROVIDER_LOGIN, GET_TWITTER_AUTH_URL, COMPLETE
• apiLoaders - list of functions for initialization providers oauth
• Functions for performing providers authorization: facebookSignIn, googleSignIn, twitterSignIn
• Auth utils - logout, handleTokenError

Action creators

Usage example:

// connect.js

import { connect } from 'react-redux'
import { signIn } from '@outcast.by/js-auth'

export default connect(() => ({}), { signIn })

signIn

Takes object as variables for the gql request:

signIn({ variables: { entity: { email: 'email', password: 'password' } } })

If you use Base Form pass it as onSubmit prop

<Form
  ...
  onSubmit={signIn}
  ...
/>

signUp

Takes object as variables for the gql request:

signUp({ variables: { entity: { email: 'email', password: 'password', passwordConfirmation: 'password' } } })

If you use Base Form pass it as onSubmit prop

If you need to pass extraParams, declare function amendVariables and pass it to Form

const amendVariables = (variables) => {
  return { ...variables, extraParams: LocalStorage.getIn('extraParams') } }
}

<Form
  ...
  onSubmit={signUp}
  amendVariables={amendVariables}
  ...
/>

forgotPassword

Takes object as variables for the gql request:

forgotPassword({ variables: { entity: { email: 'email', restoreUrl: `${window.location.origin}/auth/restore` } } })

If you use Base Form pass it as onSubmit prop and declare function amendVariables.

const amendVariables = (variables) => {
  return { ...variables, entity: { ...variables.entity, restoreUrl: `${window.location.origin}/auth/restore` } }
}

<Form
  ...
  onSubmit={forgotPassword}
  amendVariables={amendVariables}
  ...
/>

restorePassword

Takes object as variables for the gql request:

restorePassword({
  variables: { entity: { restoreHash: 'hash', password: 'password', passwordConfirmation: 'password' } },
})

hash locate in query string of url

If you use Base Form pass it as onSubmit prop and declare function amendVariables.

const { hash } = queryString.parse(window.location.search)

const amendVariables = (variables) => {
  return { ...variables, entity: { ...variables.entity, restoreHash: hash } }
}

<Form
  ...
  onSubmit={restorePassword}
  amendVariables={amendVariables}
  ...
/>

refreshToken

Takes object as variables for the gql request:

refreshToken({ variables: { entity: { refreshToken: `refreshToken` } } })

logout

Used without variables

logout()

complete

Takes object as variables for the gql request:

complete({
  variables: { entity: entityParams, oauthData: { uid: 'uid', provider: 'GOOGLE' } },
})

If you use Base Form pass it as onSubmit prop and declare function amendVariables.

const amendVariables = (variables) => {
  const { uid, provider } = oauthData
  return { ...variables, oauthData: { uid, provider: provider.toUpperCase() } }
}

<Form
  ...
  onSubmit={complete}
  amendVariables={amendVariables}
  ...
/>

getTwitterAuthUrl

Takes object as variables for the gql request:

getTwitterAuthUrl({ getTwitterAuthUrl: `${window.location.origin}${process.env.REACT_APP_TWITTER_CALLBACK_PATH}` })

Api Loaders

Usage example:

import { apiLoaders } from '@outcast.by/js-auth'

_.each(apiLoaders, (loader) => loader())

rootSignIn

Add to rootSignIn.js functions according what providers you need to use

import { facebookSignIn } from '@outcast.by/js-auth'
import { googleSignIn } from '@outcast.by/js-auth'

export default { google: googleSignIn, facebook: facebookSignIn }

These functions takes object with 3 params: useState setter, onSuccess function and history.push

const [completeAuth, setCompleteAuth] = useState({ missingFields: [], onSuccess: null, isShowCompleteAuth: false })
const onSuccess = () => history.push('/')

const onClickOauth = () => {
  facebookSignIn({ setCompleteAuth, onSuccess, pushToHistory: history.push })
}

Auth utils

1. Auth.logout() - clear cookies keys for oauth and replace window location to /auth
2. Auth.handleTokenError(action) - provide invalidTokenCallback for React module from @outcast.by/js-ext. When server response with 401 and error message is invalid_access_token this function requests new JWT data from refreshToken gql mutation. For prevent endless requests, we calculate count of refreshToken requests. If this count more than 5 performed logout()

Setup

1. Add jsAuth config to your app config

// config/common/jsAuth.js

import store from 'store'
import { FIELDS } from 'gql/auth/fields'
import LocalStorage from 'utils/LocalStorage'

export default {
  accessTokenKey: 'accessToken',
  refreshTokenKey: 'refreshToken',
  deviceUuidKey: 'deviceUuid',
  dispatch: store.dispatch,
  fields: FIELDS,
  gqlVariables: { filter: 'String', limit: 'Int', order: 'String' },
  extraParams: () => ({ ownerUuid: LocalStorage.getIn('ownerUuid') }),
  facebookId: 'process.env.REACT_APP_FACEBOOK_ID',
  googleClientId: process.env.REACT_APP_GOOGLE_CLIENT_ID,
  twitterCallbackPath: '/auth/twitter/callback',
}

accessTokenKey, refreshTokenKey and deviceUuidKey - keys for storing and getting accessToken, refreshToken and deviceUuid from cookies dispatch - used for dispatch actions in lib fields - fields for gql requests gqlVariables - additional variables for gql requests extraParams - using for creating new user by oauth with additional params facebookId and googleClientId - data for providers oauth

2. Add fields for gql example:

   // gql/auth/fields.js
   
   import gql from 'graphql-tag'
   import { USER_FIELDS } from '../users/userFields'
   
   export const FIELDS = gql`
     fragment AuthFields on Auth {
       accessToken
       refreshToken
       deviceUuid
       currentUser {
         ...UserFields
       }
     }
     ${USER_FIELDS}
   `

3. Save accessToken, refreshToken and deviceUuid to cookies Example (by redux watcher):

export function* genStoreJWT ({ data: { accessToken, refreshToken, deviceUuid } }) {
  yield Cookies.set(Config.get(['jsAuth','accessTokenKey']), accessToken)
  yield Cookies.set(Config.get(['jsAuth','refreshTokenKey']), refreshToken)
  yield Cookies.set(Config.get(['jsAuth','deviceUuidKey']), deviceUuid)
  yield LocalStorage.setIn('ownerUuid', null)
}

export const watchers = [
  takeLatest([SIGN_IN, SIGN_UP, PROVIDER_LOGIN, RESTORE_PASSWORD, REFRESH_TOKEN, COMPLETE], genStoreJWT),
]