Amazon Cognito Vuex Module

Vuex module for Amazon Cognito

Easily link your Vuex application to an Amazon Cognito User Pool.

Notes

• Federated Identities are not supported (pull request welcome).
• Email is used instead of username.
• API naming parallels AWS SDK naming.
• Module size: +-300KB, optimization pull requests are welcome.
• All actions are wrapped in Promises.

Links

• Vuex: https://vuex.vuejs.org/en/
• Cognito: https://aws.amazon.com/cognito/

Installation

npm install amazon-cognito-vuex-module --save

import Vue from 'vue';
import Vuex from 'vuex';
import App from './App.vue';
import { AmazonCognitoVuexModule } from 'amazon-cognito-vuex-module';

Vue.use(Vuex);

const store = new Vuex.Store({
  modules: {
    cognito: new AmazonCognitoVuexModule({
      region: '<region>',
      userPoolId: '<user pool id>',
      clientId: '<client id>'
    })
  }
});

new Vue({
  el: '#app',
  render: h => h(App),
  store
});

API

State

Whether user authentication is currently in progress

$store.state.cognito.authenticating

The authenticated user (null if none)

$store.state.cognito.authenticated

Actions

Check whether a user is currently authenticated, if so: update state

$store.dispatch('checkAuthentication')

Authenticate user and establish session

$store.dispatch('authenticateUser', {email: '[email protected]', password: 'foobar'})

Fetch user session

$store.dispatch('getUserSession')

Fetch attributes of the authenticated user

$store.dispatch('getUserAttributes')

Change password of the currently authenticated user (given the current and new passwords)

$store.dispatch('changePassword', {currentPassword: 'Hello', newPassword: 'World!'})

Initiate lost password procedure (send verification code to user)

$store.dispatch('forgotPassword', {email: '[email protected]'})

Confirm a new password for a given email, verification code and new password

$store.dispatch('confirmPassword', {email: '[email protected]', verificationCode: 1337, newPassword: 'dontforgetme'})

Sign up a new user for a given email and password (then sends registration verification code)

$store.dispatch('signUp', {email: '[email protected]', password: 'dontforgetme'})

Confirm a registration for a given email and registration verification code

$store.dispatch('confirmRegistration', {email: '[email protected]', verificationCode: 1337})

Re-send the registration verification code

$store.dispatch('resendConfirmationCode', {email: '[email protected]'})

Sign out user

$store.dispatch('signOut')