Wrong type definition for UserRecord

Describe your environment

• Operating System version: any
• Library version: 5.8.1
• Firebase Product: admin

Describe the problem

The types definitions of UserRecord is inconsistent with the documentation. For instance, the displayName and photoUrl may be null but in the interface UserRecord in the type definition file they are required

Steps to reproduce:

Just compare the documentation with the type definition

Relevant Code:

  interface UserRecord {
    uid: string;
    email: string;
    emailVerified: boolean;
    displayName: string; // SHOULD BE string?
    phoneNumber: string;
    photoURL: string; // SHOULD BE string?
    disabled: boolean;
    metadata: admin.auth.UserMetadata;
    providerData: admin.auth.UserInfo[];
    passwordHash?: string;
    passwordSalt?: string;
    customClaims?: Object;
    tokensValidAfterTime?: string;

    toJSON(): Object;
}

I didn’t compared all the types, just these two that relevant to my code.

[hiranya911]

This has been fixed in https://github.com/firebase/firebase-admin-node/pull/421

Typings now indicate the optional fields correctly. The documentation has also been updated to indicate (string or undefined) where it matters.

[bojeil-google]

Sorry I have been swamped lately. I will try to resolve this soon.