Make sub/user_id required in typing.

Author: yuchenshi

packages/database/src/api/Database.ts

@@ -18,7 +18,11 @@
 
 import { FirebaseApp } from '@firebase/app-types';
 import { FirebaseService } from '@firebase/app-types/private';
-import { validateArgCount, Compat, FirebaseIdToken } from '@firebase/util';
+import {
+  validateArgCount,
+  Compat,
+  EmulatorMockTokenOptions
+} from '@firebase/util';
 
 import {
   FirebaseDatabase as ExpDatabase,
@@ -64,7 +68,7 @@ export class Database implements FirebaseService, Compat<ExpDatabase> {
     host: string,
     port: number,
     options: {
-      mockUserToken?: Partial<FirebaseIdToken>;
+      mockUserToken?: EmulatorMockTokenOptions;
     } = {}
   ): void {
     useDatabaseEmulator(this._delegate, host, port, options);

packages/database/src/exp/Database.ts

@@ -27,7 +27,7 @@ import { Provider } from '@firebase/component';
 import {
   getModularInstance,
   createMockUserToken,
-  FirebaseIdToken
+  EmulatorMockTokenOptions
 } from '@firebase/util';
 
 import {
@@ -298,7 +298,7 @@ export function useDatabaseEmulator(
   host: string,
   port: number,
   options: {
-    mockUserToken?: Partial<FirebaseIdToken>;
+    mockUserToken?: EmulatorMockTokenOptions;
   } = {}
 ): void {
   db = getModularInstance(db);

packages/util/src/emulator.ts

@@ -33,7 +33,7 @@ export type FirebaseSignInProvider =
   | 'microsoft.com'
   | 'apple.com';
 
-export interface FirebaseIdToken {
+interface FirebaseIdToken {
   // Always set to https://securetoken.google.com/PROJECT_ID
   iss: string;
 
@@ -90,8 +90,11 @@ export interface FirebaseIdToken {
   uid?: never; // Try to catch a common mistake of "uid" (should be "sub" instead).
 }
 
+export type EmulatorMockTokenOptions = ({ user_id: string } | { sub: string }) &
+  Partial<FirebaseIdToken>;
+
 export function createMockUserToken(
-  token: Partial<FirebaseIdToken>,
+  token: EmulatorMockTokenOptions,
   projectId?: string
 ): string {
   if (token.uid) {

packages/util/test/emulator.test.ts

@@ -16,7 +16,7 @@
  */
 import { expect } from 'chai';
 import { base64 } from '../src/crypt';
-import { createMockUserToken, FirebaseIdToken } from '../src/emulator';
+import { createMockUserToken, EmulatorMockTokenOptions } from '../src/emulator';
 
 // Firebase Auth tokens contain snake_case claims following the JWT standard / convention.
 /* eslint-disable camelcase */
@@ -50,7 +50,7 @@ describe('createMockUserToken()', () => {
     const options = { uid: 'alice' };
 
     expect(() =>
-      createMockUserToken((options as unknown) as Partial<FirebaseIdToken>)
+      createMockUserToken((options as unknown) as EmulatorMockTokenOptions)
     ).to.throw(
       'Invalid Firebase token field "uid". Did you mean "sub" (for Firebase Auth User ID)?'
     );