roger/redux-token-auth
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #3 from kylecorbelli/add-types

Browse Source 
Make Actions Flexible Based on Developer Configuration
This commit is contained in:
Kyle Corbelli 2017-09-05 06:30:15 -07:00 committed by GitHub
commit 21bbda22a5
14 changed files with 197 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
dist/actions.js vendored
View File

@ -89,37 +89,73 @@ exports.signOutRequestFailed = function () { return ({
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Async Redux Thunk actions:
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Maybe type this even:
var theActionsExportThatShouldBeRenamed = function (authUrl) {
// what is the second argument here? it needs to contain configs for (1) userRegistrationDetails, (2) userAttributes, (3) maybe even the authUrl... just make it a simple one-argument function
// we'll also want the userAttributes to pertain to the end-user's initial state and heaven forbid reducers
// actually, userSignInCredentials, userSignOutCredentials, and verificationParams are always the same as per devise token auth
// const config = {
// authUrl: 'http://url.com',
// userAttributes: {
// firstName: 'name' // <- key is how the frontend knows it, value is how the backend knows it
// },
// userRegistrationAttributes: { <- this is for keys/vals IN ADDITION TO email, password and passwordConfirmation
// firstName: 'name'
// },
// }
// extract this service somewhere and unit test it:
var invertHash = function (hash) {
var newHash = {};
for (var key in hash) {
var val = hash[key];
newHash[val] = key;
}
return newHash;
};
// extract this service somewhere and unit test it:
var getUserAttributesFromResponse = function (userAttributes, response) {
var invertedUserAttributes = invertHash(userAttributes);
var userAttributesBackendKeys = Object.keys(invertedUserAttributes);
var userAttributesToReturn = {};
Object.keys(response.data.data).forEach(function (key) {
if (userAttributesBackendKeys.indexOf(key) !== -1) {
userAttributesToReturn[invertedUserAttributes[key]] = response.data.data[key];
}
});
return userAttributesToReturn;
};
var generateAuthActions = function (config) {
var authUrl = config.authUrl, userAttributes = config.userAttributes, userRegistrationAttributes = config.userRegistrationAttributes;
var registerUser = function (userRegistrationDetails) { return function (dispatch) {
return __awaiter(this, void 0, void 0, function () {
var firstName, email, password, passwordConfirmation, response, userAttributes, error_1;
var email, password, passwordConfirmation, data, response, userAttributesToSave, error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
dispatch(exports.registrationRequestSent());
firstName = userRegistrationDetails.firstName, email = userRegistrationDetails.email, password = userRegistrationDetails.password, passwordConfirmation = userRegistrationDetails.passwordConfirmation;
email = userRegistrationDetails.email, password = userRegistrationDetails.password, passwordConfirmation = userRegistrationDetails.passwordConfirmation;
data = {
email: email,
password: password,
password_confirmation: passwordConfirmation,
};
Object.keys(userRegistrationAttributes).forEach(function (key) {
var backendKey = userRegistrationAttributes[key];
data[backendKey] = userRegistrationDetails[key];
});
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, axios_1.default({
method: 'POST',
url: authUrl,
data: {
email: email,
name: firstName,
password: password,
password_confirmation: passwordConfirmation,
},
data: data,
})];
case 2:
response = _a.sent();
auth_1.setAuthHeaders(response.headers);
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
auth_1.persistAuthHeadersInLocalStorage(response.headers);
userAttributes = {
firstName: firstName,
};
dispatch(exports.registrationRequestSucceeded(userAttributes));
userAttributesToSave = getUserAttributesFromResponse(userAttributes, response);
dispatch(exports.registrationRequestSucceeded(userAttributesToSave)); // <- need to make this reducer more flexible
return [3 /*break*/, 4];
case 3:
error_1 = _a.sent();
@ -132,7 +168,7 @@ var theActionsExportThatShouldBeRenamed = function (authUrl) {
}; };
var verifyToken = function (verificationParams) { return function (dispatch) {
return __awaiter(this, void 0, void 0, function () {
var response, name_1, userAttributes, error_2;
var response, userAttributesToSave, error_2;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
@ -147,13 +183,11 @@ var theActionsExportThatShouldBeRenamed = function (authUrl) {
})];
case 2:
response = _a.sent();
name_1 = response.data.data.name;
auth_1.setAuthHeaders(response.headers);
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
auth_1.persistAuthHeadersInLocalStorage(response.headers);
userAttributes = {
firstName: name_1,
};
dispatch(exports.verifyTokenRequestSucceeded(userAttributes));
userAttributesToSave = getUserAttributesFromResponse(userAttributes, response);
dispatch(exports.verifyTokenRequestSucceeded(userAttributesToSave));
return [3 /*break*/, 4];
case 3:
error_2 = _a.sent();
@ -166,7 +200,7 @@ var theActionsExportThatShouldBeRenamed = function (authUrl) {
}; };
var signInUser = function (userSignInCredentials) { return function (dispatch) {
return __awaiter(this, void 0, void 0, function () {
var email, password, response, name_2, userAttributes, error_3;
var email, password, response, userAttributesToSave, error_3;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
@ -186,12 +220,10 @@ var theActionsExportThatShouldBeRenamed = function (authUrl) {
case 2:
response = _a.sent();
auth_1.setAuthHeaders(response.headers);
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
auth_1.persistAuthHeadersInLocalStorage(response.headers);
name_2 = response.data.data.name;
userAttributes = {
firstName: name_2,
};
dispatch(exports.signInRequestSucceeded(userAttributes));
userAttributesToSave = getUserAttributesFromResponse(userAttributes, response);
dispatch(exports.signInRequestSucceeded(userAttributesToSave));
return [3 /*break*/, 4];
case 3:
error_3 = _a.sent();
@ -220,6 +252,7 @@ var theActionsExportThatShouldBeRenamed = function (authUrl) {
case 2:
_a.sent();
auth_1.deleteAuthHeaders();
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
auth_1.deleteAuthHeadersFromLocalStorage();
dispatch(exports.signOutRequestSucceeded());
return [3 /*break*/, 4];
@ -232,12 +265,24 @@ var theActionsExportThatShouldBeRenamed = function (authUrl) {
});
});
}; };
var verifyCredentials = function (store) {
// Gotta check what the platform is:
if (localStorage.getItem('access-token')) {
var verificationParams = {
'access-token': localStorage.getItem('access-token'),
client: localStorage.getItem('client'),
uid: localStorage.getItem('uid'),
};
store.dispatch(verifyToken(verificationParams));
}
};
return {
registerUser: registerUser,
verifyToken: verifyToken,
signInUser: signInUser,
signOutUser: signOutUser,
verifyCredentials: verifyCredentials,
};
};
exports.default = theActionsExportThatShouldBeRenamed;
exports.default = generateAuthActions;
//# sourceMappingURL=actions.js.map

2
dist/actions.js.map vendored
View File

File diff suppressed because one or more lines are too long

2
dist/index.js vendored
View File

@ -1,7 +1,7 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var actions_1 = require("./actions");
exports.theActionsExportThatShouldBeRenamed = actions_1.default;
exports.generateAuthActions = actions_1.default;
var reducers_1 = require("./reducers");
exports.reduxTokenAuthReducer = reducers_1.default;
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

2
dist/index.js.map vendored
View File

@ -1 +1 @@
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,qCAA2D;AAIzD,8CAJK,iBAAmC,CAIL;AAHrC,uCAA8C;AAI5C,gCAJK,kBAAqB,CAIL;AAGvB,wHAAwH;AACxH,sDAAsD;AACtD,wHAAwH;AAExH,WAAW;AACX,2BAA2B;AAC3B,4BAA4B;AAC5B,EAAE;AACF,wDAAwD;AACxD,2BAA2B;AAC3B,uBAAuB;AACvB,2BAA2B;AAC3B,IAAI;AACJ,UAAU;AACV,kBAAkB;AAClB,iBAAiB;AACjB,gBAAgB;AAChB,iBAAiB;AACjB,qDAAqD"}
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,qCAA2C;AAIzC,8BAJK,iBAAmB,CAIL;AAHrB,uCAA8C;AAI5C,gCAJK,kBAAqB,CAIL;AAGvB,wHAAwH;AACxH,sDAAsD;AACtD,wHAAwH;AAExH,WAAW;AACX,2BAA2B;AAC3B,4BAA4B;AAC5B,EAAE;AACF,wDAAwD;AACxD,2BAA2B;AAC3B,uBAAuB;AACvB,2BAA2B;AAC3B,IAAI;AACJ,UAAU;AACV,kBAAkB;AAClB,iBAAiB;AACjB,gBAAgB;AAChB,iBAAiB;AACjB,qDAAqD"}

2
dist/reducers/index.js.map vendored
View File

@ -1 +1 @@
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/reducers/index.ts"],"names":[],"mappings":";;AAAA,+BAAuC;AACvC,+CAAwC;AAExC,IAAM,qBAAqB,GAAG,uBAAe,CAAC;IAC5C,WAAW,wBAAA;CACZ,CAAC,CAAA;AAEF,kBAAe,qBAAqB,CAAA;AAEpC,wHAAwH;AACxH,4EAA4E;AAC5E,wHAAwH;AAExH,0CAA0C;AAC1C,2DAA2D;AAC3D,wDAAwD;AACxD,EAAE;AACF,wCAAwC;AACxC,2CAA2C;AAC3C,qBAAqB;AACrB,KAAK;AAEL,4EAA4E"}
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/reducers/index.ts"],"names":[],"mappings":";;AAAA,+BAGc;AACd,+CAAwC;AAExC,IAAM,qBAAqB,GAAgB,uBAAe,CAAC;IACzD,WAAW,wBAAA;CACZ,CAAC,CAAA;AAEF,kBAAe,qBAAqB,CAAA;AAEpC,wHAAwH;AACxH,4EAA4E;AAC5E,wHAAwH;AAExH,0CAA0C;AAC1C,2DAA2D;AAC3D,wDAAwD;AACxD,EAAE;AACF,wCAAwC;AACxC,2CAA2C;AAC3C,qBAAqB;AACrB,KAAK;AAEL,4EAA4E"}

1
dist/types.js vendored
View File

@ -1,5 +1,4 @@
"use strict";
// Maybe make this the index.ts of a types directory so you can split things up
Object.defineProperty(exports, "__esModule", { value: true });
exports.REGISTRATION_REQUEST_SENT = 'redux-token-auth/REGISTRATION_REQUEST_SENT';
exports.REGISTRATION_REQUEST_SUCCEEDED = 'redux-token-auth/REGISTRATION_REQUEST_SUCCEEDED';

2
dist/types.js.map vendored
View File

@ -1 +1 @@
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,+EAA+E;;AAkClE,QAAA,yBAAyB,GAA8B,4CAA4C,CAAA;AAGnG,QAAA,8BAA8B,GAAmC,iDAAiD,CAAA;AAGlH,QAAA,2BAA2B,GAAgC,8CAA8C,CAAA;AAGzG,QAAA,yBAAyB,GAA8B,4CAA4C,CAAA;AAGnG,QAAA,8BAA8B,GAAmC,iDAAiD,CAAA;AAGlH,QAAA,2BAA2B,GAAgC,8CAA8C,CAAA;AAGzG,QAAA,mBAAmB,GAAwB,sCAAsC,CAAA;AAGjF,QAAA,wBAAwB,GAA6B,2CAA2C,CAAA;AAGhG,QAAA,qBAAqB,GAA0B,wCAAwC,CAAA;AAGvF,QAAA,oBAAoB,GAAyB,uCAAuC,CAAA;AAGpF,QAAA,yBAAyB,GAA8B,4CAA4C,CAAA;AAGnG,QAAA,sBAAsB,GAA2B,yCAAyC,CAAA"}
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;AAwCa,QAAA,yBAAyB,GAA8B,4CAA4C,CAAA;AAGnG,QAAA,8BAA8B,GAAmC,iDAAiD,CAAA;AAGlH,QAAA,2BAA2B,GAAgC,8CAA8C,CAAA;AAGzG,QAAA,yBAAyB,GAA8B,4CAA4C,CAAA;AAGnG,QAAA,8BAA8B,GAAmC,iDAAiD,CAAA;AAGlH,QAAA,2BAA2B,GAAgC,8CAA8C,CAAA;AAGzG,QAAA,mBAAmB,GAAwB,sCAAsC,CAAA;AAGjF,QAAA,wBAAwB,GAA6B,2CAA2C,CAAA;AAGhG,QAAA,qBAAqB,GAA0B,wCAAwC,CAAA;AAGvF,QAAA,oBAAoB,GAAyB,uCAAuC,CAAA;AAGpF,QAAA,yBAAyB,GAA8B,4CAA4C,CAAA;AAGnG,QAAA,sBAAsB,GAA2B,yCAAyC,CAAA"}

6
index.d.ts vendored Normal file
View File

@ -0,0 +1,6 @@
import { Reducer } from 'redux'
import { ActionsGeneratorExport } from './src/types'
export const reduxTokenAuthReducer: Reducer<{}>
export const generateAuthActions: ActionsGeneratorExport

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{
"name": "redux-token-auth",
"version": "0.1.0",
"version": "0.2.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

3
package.json
View File

@ -1,8 +1,9 @@
{
"name": "redux-token-auth",
"version": "0.2.0",
"version": "0.7.0",
"description": "Redux actions and reducers to integrate with Devise Token Auth",
"main": "dist/index.js",
"types": "index.d.ts",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "tsc"

111
src/actions.ts
View File

@ -1,6 +1,8 @@
import axios from 'axios'
// import { authUrl } from '../../constants' // this has to be passed in by the package user
import { Dispatch } from 'redux'
import {
Dispatch,
Store,
} from 'redux'
import {
AuthResponse,
VerificationParams,
@ -8,6 +10,7 @@ import {
UserRegistrationDetails,
UserSignInCredentials,
UserSignOutCredentials,
ActionsExport,
REGISTRATION_REQUEST_SENT,
REGISTRATION_REQUEST_SUCCEEDED,
REGISTRATION_REQUEST_FAILED,
@ -105,36 +108,78 @@ export const signOutRequestFailed = (): SignOutRequestFailedAction => ({
// Async Redux Thunk actions:
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Maybe type this even:
const theActionsExportThatShouldBeRenamed = (authUrl: string) => {
// what is the second argument here? it needs to contain configs for (1) userRegistrationDetails, (2) userAttributes, (3) maybe even the authUrl... just make it a simple one-argument function
// we'll also want the userAttributes to pertain to the end-user's initial state and heaven forbid reducers
// actually, userSignInCredentials, userSignOutCredentials, and verificationParams are always the same as per devise token auth
// const config = {
// authUrl: 'http://url.com',
// userAttributes: {
// firstName: 'name' // <- key is how the frontend knows it, value is how the backend knows it
// },
// userRegistrationAttributes: { <- this is for keys/vals IN ADDITION TO email, password and passwordConfirmation
// firstName: 'name'
// },
// }
// extract this service somewhere and unit test it:
const invertHash = (hash: { [key: string]: any }) => {
const newHash = {}
for (let key in hash) {
const val = hash[key]
newHash[val] = key
}
return newHash
}
// extract this service somewhere and unit test it:
const getUserAttributesFromResponse = (userAttributes: any, response: any) => {
const invertedUserAttributes = invertHash(userAttributes)
const userAttributesBackendKeys = Object.keys(invertedUserAttributes)
const userAttributesToReturn = {}
Object.keys(response.data.data).forEach((key: string) => {
if (userAttributesBackendKeys.indexOf(key) !== -1) {
userAttributesToReturn[invertedUserAttributes[key]] = response.data.data[key]
}
})
return userAttributesToReturn
}
const generateAuthActions = (config: { [key: string]: any }): ActionsExport => {
const {
authUrl,
userAttributes,
userRegistrationAttributes,
} = config
const registerUser = (
userRegistrationDetails: UserRegistrationDetails,
) => async function (dispatch: Dispatch<{}>): Promise<void> {
dispatch(registrationRequestSent())
const {
firstName,
email,
password,
passwordConfirmation,
} = userRegistrationDetails
const data = {
email,
password,
password_confirmation: passwordConfirmation,
}
Object.keys(userRegistrationAttributes).forEach((key: string) => {
const backendKey = userRegistrationAttributes[key]
data[backendKey] = userRegistrationDetails[key]
})
try {
const response: AuthResponse = await axios({
method: 'POST',
url: authUrl,
data: {
email,
name: firstName, // even this is tricky because it requires the user's devise configuration to allow the "name" attribute
password,
password_confirmation: passwordConfirmation,
},
data,
})
setAuthHeaders(response.headers)
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
persistAuthHeadersInLocalStorage(response.headers)
// Gonna need to refer to the passed-in User model configuration from the package user
const userAttributes: UserAttributes = {
firstName,
}
dispatch(registrationRequestSucceeded(userAttributes))
const userAttributesToSave = getUserAttributesFromResponse(userAttributes, response)
dispatch(registrationRequestSucceeded(userAttributesToSave)) // <- need to make this reducer more flexible
} catch (error) {
dispatch(registrationRequestFailed())
throw error
@ -151,14 +196,11 @@ const theActionsExportThatShouldBeRenamed = (authUrl: string) => {
url: `${authUrl}/validate_token`,
params: verificationParams,
})
const { name } = response.data.data
setAuthHeaders(response.headers)
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
persistAuthHeadersInLocalStorage(response.headers)
// Gonna need to refer to the passed-in User model configuration from the package user
const userAttributes: UserAttributes = {
firstName: name,
}
dispatch(verifyTokenRequestSucceeded(userAttributes))
const userAttributesToSave = getUserAttributesFromResponse(userAttributes, response)
dispatch(verifyTokenRequestSucceeded(userAttributesToSave))
} catch (error) {
dispatch(verifyTokenRequestFailed())
}
@ -182,13 +224,10 @@ const theActionsExportThatShouldBeRenamed = (authUrl: string) => {
},
})
setAuthHeaders(response.headers)
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
persistAuthHeadersInLocalStorage(response.headers)
// Gonna need to refer to the passed-in User model configuration from the package user
const { name } = response.data.data
const userAttributes: UserAttributes = {
firstName: name,
}
dispatch(signInRequestSucceeded(userAttributes))
const userAttributesToSave = getUserAttributesFromResponse(userAttributes, response)
dispatch(signInRequestSucceeded(userAttributesToSave))
} catch (error) {
dispatch(signInRequestFailed())
throw error
@ -206,6 +245,7 @@ const theActionsExportThatShouldBeRenamed = (authUrl: string) => {
data: userSignOutCredentials,
})
deleteAuthHeaders()
// Have to check what type of platform it is, depending on the key provided by the end-user... like "browser", "iphone", or "android", etc.:
deleteAuthHeadersFromLocalStorage()
dispatch(signOutRequestSucceeded())
} catch (error) {
@ -214,12 +254,25 @@ const theActionsExportThatShouldBeRenamed = (authUrl: string) => {
}
}
const verifyCredentials = (store: Store<{}>): void => {
// Gotta check what the platform is:
if (localStorage.getItem('access-token')) {
const verificationParams: VerificationParams = {
'access-token': localStorage.getItem('access-token') as string,
client: localStorage.getItem('client') as string,
uid: localStorage.getItem('uid') as string,
}
store.dispatch<any>(verifyToken(verificationParams))
}
}
return {
registerUser,
verifyToken,
signInUser,
signOutUser,
verifyCredentials,
}
}
export default theActionsExportThatShouldBeRenamed
export default generateAuthActions

4
src/index.ts
View File

@ -1,8 +1,8 @@
import theActionsExportThatShouldBeRenamed from './actions'
import generateAuthActions from './actions'
import reduxTokenAuthReducer from './reducers'
export {
theActionsExportThatShouldBeRenamed,
generateAuthActions,
reduxTokenAuthReducer,
}

7
src/reducers/index.ts
View File

@ -1,7 +1,10 @@
import { combineReducers } from 'redux'
import {
combineReducers,
Reducer,
} from 'redux'
import currentUser from './current-user'
const reduxTokenAuthReducer = combineReducers({
const reduxTokenAuthReducer: Reducer<{}> = combineReducers({
currentUser,
})

24
src/types.ts
View File

@ -1,4 +1,7 @@
// Maybe make this the index.ts of a types directory so you can split things up
import {
Dispatch,
Store,
} from 'redux'
// This one in particular will be a little tough because we don't know what the package user's "User" model looks like:
export interface UserAttributes {}
@ -23,6 +26,9 @@ export interface AuthHeaders {
export interface AuthResponse {
readonly headers: AuthHeaders
readonly data: {
readonly data: { [key: string]: any }
}
}
export interface VerificationParams {
@ -68,10 +74,10 @@ export type SIGNOUT_REQUEST_FAILED = 'redux-token-auth/SIGNOUT_REQUEST_FAILED'
export const SIGNOUT_REQUEST_FAILED: SIGNOUT_REQUEST_FAILED = 'redux-token-auth/SIGNOUT_REQUEST_FAILED'
export interface UserRegistrationDetails {
readonly firstName: string
readonly email: string
readonly password: string
readonly passwordConfirmation: string
readonly [key: string]: any
}
export interface UserSignInCredentials {
@ -154,3 +160,17 @@ export type ReduxAction = RegistrationRequestSentAction
| SignOutRequestSentAction
| SignOutRequestSucceededAction
| SignOutRequestFailedAction
export type ReduxAsyncAction = (input: any) => (dispatch: Dispatch<{}>) => Promise<void>
export type VerifyCredentialsFunction = (store: Store<{}>) => void
export interface ActionsExport {
readonly registerUser: ReduxAsyncAction
readonly verifyToken: ReduxAsyncAction
readonly signInUser: ReduxAsyncAction
readonly signOutUser: ReduxAsyncAction
readonly verifyCredentials: VerifyCredentialsFunction
}
export type ActionsGeneratorExport = (config: { [key: string]: any }) => ActionsExport