Added typings to configuration objects on all three packages

davidyaha · davidyaha · commit b3abeb8a27a2 · 2017-03-08T14:42:37.000+02:00
diff --git a/.eslintrc b/.eslintrc
@@ -83,7 +83,7 @@
     ],
     "flowtype/type-id-match": [
       2,
-      "^([A-Z][a-z0-9]+)+Type$"
+      "^([A-Z][a-z0-9]+)+"
     ],
     "flowtype/union-intersection-spacing": [
       2,
diff --git a/packages/client/src/AccountsClient.js b/packages/client/src/AccountsClient.js
@@ -17,6 +17,7 @@ import config from './config';
 import createStore from './createStore';
 import reducer, { loggingIn, setUser, clearUser, setTokens, clearTokens as clearStoreTokens } from './module';
 import type { TransportInterface } from './TransportInterface';
+import type { TokenStorage, AccountsClientConfiguration } from './config';
 
 const isValidUserObject = (user: PasswordLoginUserIdentityType) => has(user, 'user') || has(user, 'email') || has(user, 'id');
 
@@ -26,21 +27,15 @@ const REFRESH_TOKEN = 'accounts:refreshToken';
 const getTokenKey = (type: string, options: Object) =>
   (isString(options.tokenStoragePrefix) && options.tokenStoragePrefix.length > 0 ? `${options.tokenStoragePrefix}:${type}` : type);
 
-export interface TokenStorage {
-  getItem(key: string): Promise<string>,
-  removeItem(key: string): Promise<string>,
-  setItem(key: string, value: string): Promise<string>
-}
-
 export class AccountsClient {
-  options: Object;
+  options: AccountsClientConfiguration;
   transport: TransportInterface;
-  store: Store<Map<string, any>, Object>;
+  store: Store<Object, Object>;
   storage: TokenStorage;
 
-  constructor(options: Object, transport: TransportInterface) {
+  constructor(options: AccountsClientConfiguration, transport: TransportInterface) {
     this.options = options;
-    this.storage = options.tokenStorage;
+    this.storage = options.tokenStorage || config.tokenStorage;
     if (!transport) {
       throw new AccountsError('A REST or GraphQL transport is required');
     }
@@ -51,9 +46,10 @@ export class AccountsClient {
       options.reduxLogger,
     ] : [];
 
+    const reduxStoreKey = options.reduxStoreKey || config.reduxStoreKey;
     this.store = options.store || createStore({
       reducers: {
-        [options.reduxStoreKey]: reducer,
+        [reduxStoreKey]: reducer,
       },
       middleware,
     });
@@ -124,6 +120,7 @@ export class AccountsClient {
     const { accessToken, refreshToken } = await this.tokens();
     if (accessToken && refreshToken) {
       try {
+        this.store.dispatch(loggingIn(true));
         const decodedRefreshToken = jwtDecode(refreshToken);
         const currentTime = Date.now() / 1000;
         // Refresh token is expired, user must sign back in
@@ -134,12 +131,14 @@ export class AccountsClient {
           // Request a new token pair
           const refreshedSession : LoginReturnType =
             await this.transport.refreshTokens(accessToken, refreshToken);
+          this.store.dispatch(loggingIn(false));
 
           await this.storeTokens(refreshedSession);
           this.store.dispatch(setTokens(refreshedSession.tokens));
           this.store.dispatch(setUser(refreshedSession.user));
         }
       } catch (err) {
+        this.store.dispatch(loggingIn(false));
         this.clearTokens();
         this.clearUser();
         throw new AccountsError('falsy token provided');
@@ -187,7 +186,7 @@ export class AccountsClient {
 
   async loginWithPassword(user: PasswordLoginUserType,
                           password: ?string,
-                          callback?: Function): Promise<void> {
+                          callback?: Function): Promise<LoginReturnType> {
     if (!password || !user) {
       throw new AccountsError('Unrecognized options for login request', user, 400);
     }
@@ -202,7 +201,11 @@ export class AccountsClient {
       await this.storeTokens(res);
       this.store.dispatch(setTokens(res.tokens));
       this.store.dispatch(setUser(res.user));
-      this.options.onSignedInHook();
+
+      if (this.options.onSignedInHook) {
+        this.options.onSignedInHook();
+      }
+
       if (callback && isFunction(callback)) {
         callback(null, res);
       }
@@ -238,7 +241,10 @@ export class AccountsClient {
       if (callback && isFunction(callback)) {
         callback();
       }
-      this.options.onSignedOutHook();
+
+      if (this.options.onSignedOutHook) {
+        this.options.onSignedOutHook();
+      }
     } catch (err) {
       if (callback && isFunction(callback)) {
         callback(err);
@@ -264,6 +270,7 @@ export class AccountsClient {
   }
 
   async requestPasswordReset(email?: string): Promise<void> {
+    if (!email) throw new AccountsError('Email must be provided');
     try {
       await this.transport.sendResetPasswordEmail(email);
     } catch (err) {
@@ -272,6 +279,7 @@ export class AccountsClient {
   }
 
   async requestVerificationEmail(email?: string): Promise<void> {
+    if (!email) throw new AccountsError('Email must be provided');
     try {
       await this.transport.sendVerificationEmail(email);
     } catch (err) {
diff --git a/packages/client/src/AccountsClient.spec.js b/packages/client/src/AccountsClient.spec.js
@@ -494,7 +494,7 @@ describe('Accounts', () => {
       const error = 'something bad';
       Accounts.config({}, { sendResetPasswordEmail: () => Promise.reject({ message: error }) });
       try {
-        await Accounts.requestPasswordReset();
+        await Accounts.requestPasswordReset('email');
         throw new Error();
       } catch (err) {
         expect(err.message).toEqual(error);
@@ -515,7 +515,7 @@ describe('Accounts', () => {
       const error = 'something bad';
       Accounts.config({}, { sendVerificationEmail: () => Promise.reject({ message: error }) });
       try {
-        await Accounts.requestVerificationEmail();
+        await Accounts.requestVerificationEmail('email');
         throw new Error();
       } catch (err) {
         expect(err.message).toEqual(error);
diff --git a/packages/client/src/TransportInterface.js b/packages/client/src/TransportInterface.js
@@ -10,5 +10,9 @@ export interface TransportInterface {
   createUser(user: CreateUserType): Promise<string>,
   loginWithPassword(user: PasswordLoginUserType, password: string): Promise<LoginReturnType>,
   logout(accessToken: string): Promise<void>,
-  refreshTokens(accessToken: string, refreshToken: string) : Promise<LoginReturnType>
+  refreshTokens(accessToken: string, refreshToken: string) : Promise<LoginReturnType>,
+  verifyEmail(token: string): Promise<void>,
+  resetPassword(token: string, newPassword: string): Promise<void>,
+  sendResetPasswordEmail(email: string): Promise<void>,
+  sendVerificationEmail(email: string): Promise<void>
 }
diff --git a/packages/client/src/config.js b/packages/client/src/config.js
@@ -1,7 +1,44 @@
+// @flow
+
 import { config as sharedConfig } from '@accounts/common';
+import type { AccountsCommonConfiguration } from '@accounts/common';
+import type { Store } from 'redux';
 import AccountsClient from './AccountsClient';
 import redirect from './redirect';
 
+export interface TokenStorage {
+  getItem(key: string): Promise<string>,
+  removeItem(key: string): Promise<string>,
+  setItem(key: string, value: string): Promise<string>
+}
+
+export type AccountsClientConfiguration = AccountsCommonConfiguration & {
+  store?: ?Store<Object, Object>,
+  reduxLogger?: ?Object,
+  reduxStoreKey?: string,
+  tokenStorage?: ?TokenStorage,
+  server?: string,
+  tokenStoragePrefix?: string,
+  title?: string,
+  requestPermissions?: Array<any>,
+  requestOfflineToken?: Object,
+  forceApprovalPrompt?: Object,
+  requireEmailVerification?: boolean,
+  loginPath?: string,
+  signUpPath?: ?string,
+  resetPasswordPath?: ?string,
+  profilePath?: string,
+  changePasswordPath?: ?string,
+  homePath?: string,
+  signOutPath?: string,
+  onEnrollAccountHook?: Function,
+  onResetPasswordHook?: Function,
+  onVerifyEmailHook?: Function,
+  onSignedInHook?: Function,
+  onSignedOutHook?: Function,
+  loginOnSignUp?: boolean
+};
+
 export default {
   ...sharedConfig,
   store: null,
diff --git a/packages/client/src/index.js b/packages/client/src/index.js
@@ -1,8 +1,8 @@
 // @flow
+import type { TokenStorage } from './config';
+import type { TransportInterface } from './TransportInterface';
 
 import Accounts, { AccountsClient } from './AccountsClient';
-import type { TokenStorage } from './AccountsClient';
-import type { TransportInterface } from './TransportInterface';
 import config from './config';
 import reducer from './module';
 
diff --git a/packages/common/src/config.js b/packages/common/src/config.js
@@ -1,17 +1,31 @@
+// @flow
 import { EMAIL_ONLY } from './passwordSignupFields';
-// eslint-disable-next-line import/no-named-as-default
+import type { PasswordSignupFields } from './passwordSignupFields';
 
-export default {
+export type AccountsCommonConfiguration = {
+  siteUrl?: string,
+  sendVerificationEmail?: boolean,
+  sendEnrollmentEmail?: boolean,
+  sendWelcomeEmail?: boolean,
+  forbidClientAccountCreation?: boolean,
+  restrictCreationByEmailDomain?: ?string,
+  passwordResetTokenExpirationInDays?: number,
+  passwordEnrollTokenExpirationInDays?: number,
+  passwordSignupFields?: PasswordSignupFields,
+  minimumPasswordLength?: number,
+  path?: string
+};
+
+export default ({
   siteUrl: 'http://localhost:3000',
   sendVerificationEmail: false,
   sendEnrollmentEmail: false,
   sendWelcomeEmail: false,
   forbidClientAccountCreation: false,
   restrictCreationByEmailDomain: null,
-  loginExpirationInDays: 90,
   passwordResetTokenExpirationInDays: 3,
   passwordEnrollTokenExpirationInDays: 30,
   passwordSignupFields: EMAIL_ONLY,
   minimumPasswordLength: 7,
   path: '/accounts',
-};
+}: AccountsCommonConfiguration);
diff --git a/packages/common/src/index.js b/packages/common/src/index.js
@@ -5,6 +5,7 @@ import * as validators from './validators';
 import { AccountsError } from './errors';
 import toUsernameAndEmail from './toUsernameAndEmail';
 import config from './config';
+import type { AccountsCommonConfiguration } from './config';
 
 import type {
   UserObjectType,
@@ -24,6 +25,7 @@ export type {
   LoginReturnType,
   TokensType,
   SessionType,
+  AccountsCommonConfiguration,
 };
 
 export {
diff --git a/packages/common/src/passwordSignupFields.js b/packages/common/src/passwordSignupFields.js
@@ -2,3 +2,9 @@ export const EMAIL_ONLY = 'EMAIL_ONLY';
 export const USERNAME_AND_EMAIL = 'USERNAME_AND_EMAIL';
 export const USERNAME_AND_OPTIONAL_EMAIL = 'USERNAME_AND_OPTIONAL_EMAIL';
 export const USERNAME_ONLY = 'USERNAME_ONLY';
+
+export type PasswordSignupFields =
+  EMAIL_ONLY |
+  USERNAME_AND_EMAIL |
+  USERNAME_AND_OPTIONAL_EMAIL |
+  USERNAME_ONLY;
diff --git a/packages/common/src/validators.js b/packages/common/src/validators.js
@@ -10,7 +10,7 @@ export const isEmail = (email: ?string) => {
 
 export const validateEmail = (email: ?string): boolean => {
   const isValid = !isEmpty(trim(email || '')) && isEmail(email);
-  return isValid;
+  return Boolean(isValid);
 };
 
 export const validatePassword = (password: ?string): boolean => {
@@ -21,5 +21,5 @@ export const validatePassword = (password: ?string): boolean => {
 export const validateUsername = (username: ?string): boolean => {
   const usernameRegex = /^[a-zA-Z][a-zA-Z0-9]*$/;
   const isValid = username && !isEmpty(trim(username)) && usernameRegex.test(username);
-  return isValid;
+  return Boolean(isValid);
 };
diff --git a/packages/server/src/AccountsServer.js b/packages/server/src/AccountsServer.js
@@ -27,9 +27,10 @@ import Email from './email';
 import emailTemplates from './emailTemplates';
 import type { EmailConnector } from './email';
 import type { EmailTemplatesType } from './emailTemplates';
+import type { AccountsServerConfiguration, PasswordAuthenticator } from './config';
 
 export class AccountsServer {
-  _options: Object
+  _options: AccountsServerConfiguration
   db: DBInterface
   email: EmailConnector
   emailTemplates: EmailTemplatesType
@@ -40,7 +41,7 @@ export class AccountsServer {
    * @param {Object} db - DBInterface for AccountsServer.
    * @returns {Object} - Return the options.
    */
-  config(options: Object, db: DBInterface) {
+  config(options: AccountsServerConfiguration, db: DBInterface) {
     this._options = {
       ...config,
       ...options,
@@ -49,10 +50,10 @@ export class AccountsServer {
       throw new AccountsError('A database driver is required');
     }
     this.db = db;
-    if (options.sendMail) {
-      this.email = { sendMail: options.sendMail };
+    if (this._options.sendMail) {
+      this.email = { sendMail: this._options.sendMail };
     } else {
-      this.email = new Email(config.email);
+      this.email = new Email(this._options.email);
     }
     this.emailTemplates = emailTemplates;
   }
@@ -115,7 +116,7 @@ export class AccountsServer {
   }
 
   // eslint-disable-next-line max-len
-  async _externalPasswordAuthenticator(authFn: Function, user: PasswordLoginUserType, password: string): Promise<any> {
+  async _externalPasswordAuthenticator(authFn: PasswordAuthenticator, user: PasswordLoginUserType, password: string): Promise<any> {
     return authFn(user, password);
   }
 
@@ -237,17 +238,17 @@ export class AccountsServer {
    * @returns {Promise<Object>} - Return a new accessToken and refreshToken.
    */
   createTokens(sessionId: string): TokensType {
-    const { tokenSecret, tokenConfigs } = this._options;
+    const { tokenSecret = config.tokenSecret, tokenConfigs = config.tokenConfigs } = this._options;
     const accessToken = generateAccessToken({
       data: {
         sessionId,
       },
       secret: tokenSecret,
-      config: tokenConfigs.accessToken,
+      config: tokenConfigs.accessToken || {},
     });
     const refreshToken = generateRefreshToken({
       secret: tokenSecret,
-      config: tokenConfigs.refreshToken,
+      config: tokenConfigs.refreshToken || {},
     });
     return { accessToken, refreshToken };
   }
@@ -481,7 +482,9 @@ export class AccountsServer {
     }
     const token = generateRandomToken();
     await this.db.addEmailVerificationToken(userId, address, token);
-    const verifyEmailUrl = `${this._options.siteUrl}/verify-email/${token}`;
+
+    const siteUrl = this._options.siteUrl || config.siteUrl;
+    const verifyEmailUrl = `${siteUrl}/verify-email/${token}`;
     await this.email.sendMail({
       from: this.emailTemplates.verifyEmail.from ?
         this.emailTemplates.verifyEmail.from : this.emailTemplates.from,
@@ -507,7 +510,9 @@ export class AccountsServer {
     address = this._getFirstUserEmail(user, address); // eslint-disable-line no-param-reassign
     const token = generateRandomToken();
     await this.db.addResetPasswordToken(userId, address, token);
-    const resetPasswordUrl = `${this._options.siteUrl}/reset-password/${token}`;
+
+    const siteUrl = this._options.siteUrl || config.siteUrl;
+    const resetPasswordUrl = `${siteUrl}/reset-password/${token}`;
     await this.email.sendMail({
       from: this.emailTemplates.resetPassword.from ?
         this.emailTemplates.resetPassword.from : this.emailTemplates.from,
@@ -533,7 +538,9 @@ export class AccountsServer {
     address = this._getFirstUserEmail(user, address); // eslint-disable-line no-param-reassign
     const token = generateRandomToken();
     await this.db.addResetPasswordToken(userId, address, token, 'enroll');
-    const enrollAccountUrl = `${this._options.siteUrl}/enroll-account/${token}`;
+
+    const siteUrl = this._options.siteUrl || config.siteUrl;
+    const enrollAccountUrl = `${siteUrl}/enroll-account/${token}`;
     await this.email.sendMail({
       from: this.emailTemplates.enrollAccount.from ?
         this.emailTemplates.enrollAccount.from : this.emailTemplates.from,
diff --git a/packages/server/src/config.js b/packages/server/src/config.js
