Fixes optional fields in UserRecord types to be optional. (#421)

* Fixes optional fields in UserRecord types to be optional.
References will be updated to reflect that too.

* Fixes UserRecord#tokensValidAfterTime to be undefined instead of null
when not available.

* Added CHANGELOG note.

Author: bojeil-google

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Unreleased
 
--
+- [fixed] Fixed optional fields in UserRecord types to be optional.
 
 # v6.4.0
 

src/auth/user-record.ts

@@ -186,7 +186,7 @@ export class UserRecord {
     if (typeof response.validSince !== 'undefined') {
       validAfterTime = parseDate(response.validSince * 1000);
     }
-    utils.addReadonlyGetter(this, 'tokensValidAfterTime', validAfterTime);
+    utils.addReadonlyGetter(this, 'tokensValidAfterTime', validAfterTime || undefined);
   }
 
   /** @return {object} The plain object representation of the user record. */

src/index.d.ts

@@ -104,11 +104,11 @@ declare namespace admin.auth {
 
   interface UserRecord {
     uid: string;
-    email: string;
+    email?: string;
     emailVerified: boolean;
-    displayName: string;
-    phoneNumber: string;
-    photoURL: string;
+    displayName?: string;
+    phoneNumber?: string;
+    photoURL?: string;
     disabled: boolean;
     metadata: admin.auth.UserMetadata;
     providerData: admin.auth.UserInfo[];

test/unit/auth/auth.spec.ts

@@ -456,7 +456,7 @@ describe('Auth', () => {
       const noValidSinceExpectedUserRecord =
          getValidUserRecord(noValidSinceGetAccountInfoResponse);
       // Confirm null tokensValidAfterTime on user.
-      expect(noValidSinceExpectedUserRecord.tokensValidAfterTime).to.be.null;
+      expect(noValidSinceExpectedUserRecord.tokensValidAfterTime).to.be.undefined;
       // Simulate getUser returns the expected user with no validSince.
       const getUserStub = sinon.stub(Auth.prototype, 'getUser')
         .returns(Promise.resolve(noValidSinceExpectedUserRecord));
@@ -660,7 +660,7 @@ describe('Auth', () => {
       const noValidSinceExpectedUserRecord =
          getValidUserRecord(noValidSinceGetAccountInfoResponse);
       // Confirm null tokensValidAfterTime on user.
-      expect(noValidSinceExpectedUserRecord.tokensValidAfterTime).to.be.null;
+      expect(noValidSinceExpectedUserRecord.tokensValidAfterTime).to.be.undefined;
       // Simulate getUser returns the expected user with no validSince.
       const getUserStub = sinon.stub(Auth.prototype, 'getUser')
         .returns(Promise.resolve(noValidSinceExpectedUserRecord));

test/unit/auth/user-record.spec.ts

@@ -546,8 +546,8 @@ describe('UserRecord', () => {
       }).to.throw(Error);
     });
 
-    it('should return null tokensValidAfterTime when not available', () => {
-      expect(userRecordNoValidSince.tokensValidAfterTime).to.be.null;
+    it('should return undefined tokensValidAfterTime when not available', () => {
+      expect(userRecordNoValidSince.tokensValidAfterTime).to.be.undefined;
     });
 
     it('should return expected metadata', () => {
@@ -637,8 +637,8 @@ describe('UserRecord', () => {
       expect(userRecord.toJSON()).to.deep.equal(getUserJSON());
     });
 
-    it('should return null tokensValidAfterTime when not available', () => {
-      expect((userRecordNoValidSince.toJSON() as any).tokensValidAfterTime).to.be.null;
+    it('should return undefined tokensValidAfterTime when not available', () => {
+      expect((userRecordNoValidSince.toJSON() as any).tokensValidAfterTime).to.be.undefined;
     });
   });
 });