This small library serves as a wrapper of Amazon Cognito for Vuex.
All actions return a promise to be able to easily control execution flow.
Retrieve current user and save user schema to store.
Returned promise rejects with an error if there is no previously authenticated user:
{
message: "Can't retrieve current user",
}
Authenticates a user with username and password.
Usage:
this.$store.dispatch('authenticateUser', {
username: "[email protected]",
password: "testbatmanpass"
});
Returned promise resolves with an object with userConfirmationNecessary flag:
this.$store.dispatch('signUp', { ... }).then(({ userConfirmationNecessary }) => { ... })
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Creates user with the following payload:
{
username: 'test',
password: 'Qwerty123!',
attributes: {
email: '[email protected]',
name: 'MegaTest',
phone_number: '+15553334444',
}
}
You can change username to be any value, for example, an email address or UUID. It's important to know that Amazon Cognito doesn't allow changing username after signing up.
Usage:
this.$store.dispatch('signUp', { ... });
Returned promise resolves with an object with userConfirmationNecessary flag:
this.$store.dispatch('signUp', { ... }).then(({ userConfirmationNecessary }) => { ... })
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Confirms user registration with username and code:
Usage:
this.$store.dispatch('confirmRegistration', {
username: 'testusername',
code: '123456'
});
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Resends user confirmation code:
Usage:
this.$store.dispatch('resendConfirmationCode', {
username: 'testusername'
});
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Starts forgot password flow:
Usage:
this.$store.dispatch('forgotPassword', {
username: 'testusername'
});
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Sets a new password with the code received after calling forgotPassword action:
Usage:
this.$store.dispatch('confirmPassword', {
username: 'testusername',
code: '123456',
newPassword: 'qwerty123'
});
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Only for authenticated users
Changes user password:
Usage:
this.$store.dispatch('changePassword', {
oldPassword: '123qwerty',
newPassword: 'qwerty123'
});
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Only for authenticated users
Updates user attributes. Payload is an object where key is an attribute name:
{
email: 'value',
phone_number: '[email protected]',
username: 'batman' // see documentation on Cognito attributes
}
Usage:
this.$store.dispatch('updateAttributes', {
email: '[email protected]',
name: 'Bruce',
phone_number: '+15551234567',
});
Returned promise rejects with the following error object:
{
code: "NotAuthorizedException", // Amazon Cognito error code
message: "..." // Error message returned from Amazon Cognito servers
}
Removes user from the store (for example, $store.cognito.user) and Cognito session from Local Storage.
Returned promise rejects with an error if there is no previously authenticated user:
{
message: "User is unauthenticated",
}
# install dependencies
npm install
# serve examples with hot reload at localhost:8080
npm run dev
# run all tests
npm test
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent