feat: Ensure better type safety

Author: Francesco Novy

addon/errors/cognito.ts

@@ -1,3 +1,5 @@
+import { UserAttributes } from "ember-cognito-identity/services/cognito";
+
 export interface AmazonCognitoIdentityJsError {
   message: string;
   name: string;
@@ -36,10 +38,10 @@ export class CognitoError extends Error {
 
 // Note: This error is never thrown by dispatchError, but only manually in cognito._authenticate()
 export class NewPasswordRequiredError extends CognitoError {
-  userAttributes: Object;
-  requiredAttributes: Object;
+  userAttributes: UserAttributes;
+  requiredAttributes: UserAttributes;
 
-  constructor(userAttributes: Object, requiredAttributes: Object) {
+  constructor(userAttributes: UserAttributes, requiredAttributes: UserAttributes) {
     super('A new password must be set.');
 
     this.name = 'NewPasswordRequiredError';

addon/services/cognito.ts

@@ -24,11 +24,13 @@ import { timeout } from 'ember-concurrency';
 
 interface CognitoData {
   cognitoUser: CognitoUser;
-  userAttributes: Object;
+  userAttributes: UserAttributes;
   cognitoUserSession: CognitoUserSession;
   jwtToken: string;
 }
 
+export type UserAttributes = { [key: string]: any };
+
 export default class CognitoService extends Service {
   @service router: RouterService;
 
@@ -127,7 +129,7 @@ export default class CognitoService extends Service {
     }
 
     let promise = new RSVPPromise((resolve, reject) => {
-      this.cognitoData.cognitoUser.refreshSession(refreshToken, (error) => {
+      this.cognitoData!.cognitoUser.refreshSession(refreshToken, (error) => {
         if (error) {
           return reject(dispatchError(error));
         }
@@ -140,26 +142,32 @@ export default class CognitoService extends Service {
     return promise;
   }
 
-  async _loadUserDataAndAccessToken(): Promise<any> {
+  async _loadUserDataAndAccessToken(): Promise<CognitoData | null> {
     let { userPool } = this;
 
-    let promise = new RSVPPromise((resolve, reject) => {
-      let cognitoUser = userPool.getCurrentUser();
-      if (!cognitoUser) {
-        return reject(null);
-      }
+    let cognitoUser = userPool.getCurrentUser();
+    if (!cognitoUser) {
+      return null;
+    }
+
+    return this._loadCognitoUserSession(cognitoUser);
+  }
 
+  async _loadCognitoUserSession(
+    cognitoUser: CognitoUser
+  ): Promise<CognitoData> {
+    let promise: Promise<CognitoData> = new RSVPPromise((resolve, reject) => {
       cognitoUser.getSession(
         (
           error: AmazonCognitoIdentityJsError | null,
           cognitoUserSession: CognitoUserSession
         ) => {
           if (error) {
-            cognitoUser.signOut();
+            cognitoUser!.signOut();
             return reject(dispatchError(error));
           }
 
-          this._getUserAttributes(cognitoUser).then(
+          this._getUserAttributes(cognitoUser!).then(
             (userAttributes) => {
               let jwtToken = cognitoUserSession.getAccessToken().getJwtToken();
 
@@ -206,7 +214,7 @@ export default class CognitoService extends Service {
     await this.restoreAndLoad();
     await this.onAuthenticated();
 
-    return this.cognitoData;
+    return this.cognitoData!;
   }
 
   /*
@@ -228,7 +236,10 @@ export default class CognitoService extends Service {
   }): Promise<any> {
     assert('cognitoData is already setup', !this.cognitoData);
 
-    cognitoUser = cognitoUser || this._createCognitoUser({ username });
+    let actualCognitoUser =
+      typeof cognitoUser === 'undefined'
+        ? this._createCognitoUser({ username })
+        : cognitoUser;
 
     let authenticationData = {
       Username: username,
@@ -237,7 +248,7 @@ export default class CognitoService extends Service {
     let authenticationDetails = new AuthenticationDetails(authenticationData);
 
     let promise = new RSVPPromise((resolve, reject) => {
-      cognitoUser.authenticateUser(authenticationDetails, {
+      actualCognitoUser.authenticateUser(authenticationDetails, {
         onSuccess: () => {
           resolve(cognitoUser);
         },
@@ -275,6 +286,10 @@ export default class CognitoService extends Service {
 
   invalidateAccessTokens(): Promise<any> {
     let promise = new RSVPPromise((resolve, reject) => {
+      if (!this.cognitoData) {
+        return reject();
+      }
+
       this.cognitoData.cognitoUser.globalSignOut({
         onSuccess: () => {
           this.onUnauthenticated();
@@ -401,7 +416,7 @@ export default class CognitoService extends Service {
       !!this.cognitoData
     );
 
-    let { cognitoUser } = this.cognitoData;
+    let { cognitoUser } = this.cognitoData!;
 
     let promise = new RSVPPromise((resolve, reject) => {
       cognitoUser.changePassword(oldPassword, newPassword, function (error) {
@@ -423,7 +438,7 @@ export default class CognitoService extends Service {
       !!this.cognitoData
     );
 
-    let { cognitoUser } = this.cognitoData;
+    let { cognitoUser } = this.cognitoData!;
 
     let attributeList: ICognitoUserAttributeData[] = Object.keys(
       attributes
@@ -444,7 +459,7 @@ export default class CognitoService extends Service {
 
           this._getUserAttributes(cognitoUser)
             .then((userAttributes) => {
-              this.cognitoData.userAttributes = userAttributes;
+              this.cognitoData!.userAttributes = userAttributes;
               resolve(userAttributes);
             })
             .catch(reject);
@@ -482,6 +497,10 @@ export default class CognitoService extends Service {
           return reject(dispatchError(error));
         }
 
+        if (!cognitoUserAttributes) {
+          return resolve({});
+        }
+
         let userAttributes: { [index: string]: string } = {};
         cognitoUserAttributes.forEach((cognitoUserAttribute) => {
           let name = cognitoUserAttribute.getName();

tests/dummy/app/components/cognito-login-form.ts

@@ -7,7 +7,9 @@ import {
 } from 'ember-cognito-identity/errors/cognito';
 import { dropTask } from 'ember-concurrency-decorators';
 import { tracked } from '@glimmer/tracking';
-import CognitoService from 'ember-cognito-identity/services/cognito';
+import CognitoService, {
+  UserAttributes,
+} from 'ember-cognito-identity/services/cognito';
 import RouterService from '@ember/routing/router-service';
 
 export default class CognitoLoginForm extends Component {
@@ -66,7 +68,9 @@ export default class CognitoLoginForm extends Component {
 
   // This can be overwritten
   // eslint-disable-next-line no-unused-vars
-  _getNewPasswordAttributes(_options: Object): undefined | Object {
+  _getNewPasswordAttributes(
+    _options: UserAttributes
+  ): undefined | UserAttributes {
     return undefined;
   }
 

tests/dummy/app/components/cognito-reset-password-form.ts

@@ -18,9 +18,9 @@ export default class CognitoResetPasswordForm extends Component<Args> {
   @service router: RouterService;
 
   // Properties
-  @tracked password: string;
-  @tracked selectedUsername: string;
-  @tracked selectedVerificationCode: string;
+  @tracked password?: string;
+  @tracked selectedUsername?: string;
+  @tracked selectedVerificationCode?: string;
   @tracked error: CognitoError | null;
   @tracked showPasswordForm: boolean = false;
 

tests/dummy/app/components/cognito-reset-password-form/select-username.ts

@@ -11,7 +11,7 @@ export default class CognitoResetPasswordFormSelectUsername extends Component<
   Args
 > {
   // Properties
-  @tracked currentUsername: string;
+  @tracked currentUsername?: string;
 
   constructor(owner: any, args: Args) {
     super(owner, args);

tests/dummy/app/components/cognito-reset-password-form/update-password.ts

@@ -12,8 +12,8 @@ export default class CognitoResetPasswordFormUpdatePassword extends Component<
   Args
 > {
   // Properties
-  @tracked currentVerificationCode: string;
-  @tracked password: string;
+  @tracked currentVerificationCode?: string;
+  @tracked password?: string;
 
   constructor(owner: any, args: Args) {
     super(owner, args);

tsconfig.json

@@ -7,7 +7,7 @@
     "noImplicitAny": true,
     "noImplicitThis": true,
     "alwaysStrict": true,
-    "strictNullChecks": false,
+    "strictNullChecks": true,
     "strictPropertyInitialization": false,
     "noFallthroughCasesInSwitch": true,
     "noUnusedLocals": true,
@@ -19,9 +19,7 @@
     "inlineSources": true,
     "baseUrl": ".",
     "module": "es6",
-    "esModuleInterop": true,
     "experimentalDecorators": true,
-    "skipLibCheck": true,
     "paths": {
       "dummy/tests/*": ["tests/*"],
       "dummy/*": ["tests/dummy/app/*", "app/*"],