Fix auth api extractor warnings

Author: hsubox76

common/api-review/auth-exp.api.md

@@ -82,7 +82,7 @@ export function applyActionCode(auth: Auth, oobCode: string): Promise<void>;
 export interface Auth {
     readonly config: Config;
     readonly currentUser: User | null;
-    // Warning: (ae-forgotten-export) The symbol "EmulatorConfig" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "EmulatorConfig" needs to be exported by the entry point index.doc.d.ts
     readonly emulatorConfig: EmulatorConfig | null;
     languageCode: string | null;
     readonly name: string;
@@ -102,14 +102,14 @@ export class AuthCredential {
     protected constructor(
     providerId: string,
     signInMethod: string);
-    // Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
+    // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     _getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
     // @internal (undocumented)
     _getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
-    // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     _linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
@@ -277,6 +277,9 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
     disableWarnings: boolean;
 }): void;
 
+// @public
+export const cordovaPopupRedirectResolver: PopupRedirectResolver;
+
 // @public
 export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
 
@@ -330,7 +333,7 @@ export class EmailAuthProvider implements AuthProvider {
 
 export { ErrorFn }
 
-// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
 //
 // @public
 export class FacebookAuthProvider extends BaseOAuthProvider {
@@ -470,7 +473,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
 export class OAuthCredential extends AuthCredential {
     accessToken?: string;
     static fromJSON(json: string | object): OAuthCredential | null;
-    // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     static _fromParams(params: OAuthCredentialParams): OAuthCredential;
@@ -549,7 +552,7 @@ export class PhoneAuthCredential extends AuthCredential {
     _getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
     // @internal (undocumented)
     _linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
-    // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     _makeVerificationRequest(): SignInWithPhoneNumberRequest;
@@ -622,6 +625,9 @@ export interface ReactNativeAsyncStorage {
     setItem(key: string, value: string): Promise<void>;
 }
 
+// @public
+export const reactNativeLocalPersistence: Persistence;
+
 // @public
 export function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
 
@@ -634,14 +640,14 @@ export function reauthenticateWithPopup(user: User, provider: AuthProvider, reso
 // @public
 export function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
 
-// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
 //
 // @public
 export class RecaptchaVerifier implements ApplicationVerifierInternal {
-    // Warning: (ae-forgotten-export) The symbol "Parameters" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Parameters" needs to be exported by the entry point index.doc.d.ts
     constructor(containerOrId: HTMLElement | string, parameters: Parameters_2, authExtern: Auth);
     clear(): void;
-    // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
     //
     // @internal (undocumented)
     readonly _recaptchaLoader: ReCaptchaLoader;
@@ -655,7 +661,7 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
 // @public
 export function reload(user: User): Promise<void>;
 
-// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
 //
 // @public
 export class SAMLAuthProvider extends FederatedAuthProvider {
@@ -799,4 +805,6 @@ export function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCode
 export function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;
 
 
+// (No @packageDocumentation comment for this package)
+
 ```

packages-exp/auth-exp/index.rn.ts

@@ -25,7 +25,7 @@
 import { AsyncStorage } from 'react-native';
 
 import { FirebaseApp, getApp, _getProvider } from '@firebase/app-exp';
-import { Auth } from './src/model/public_types';
+import { Auth, Persistence } from './src/model/public_types';
 
 import { initializeAuth } from './src';
 import { registerAuth } from './src/core/auth/register';
@@ -41,7 +41,7 @@ export * from './src';
  *
  * @public
  */
-export const reactNativeLocalPersistence =
+export const reactNativeLocalPersistence: Persistence =
   getReactNativePersistence(AsyncStorage);
 
 export function getAuth(app: FirebaseApp = getApp()): Auth {

packages-exp/auth-exp/src/core/auth/emulator.ts

@@ -36,7 +36,8 @@ import { _castAuth } from './auth_impl';
  *
  * @param auth - The {@link Auth} instance.
  * @param url - The URL at which the emulator is running (eg, 'http://localhost:9099').
- * @param options.disableWarnings - (Optional: default false) Disable the warning banner attached to the DOM
+ * @param options - Optional. `options.disableWarnings` defaults to `false`. Set it to
+ * `true` to disable the warning banner attached to the DOM.
  *
  * @public
  */

packages-exp/auth-exp/src/core/providers/oauth.ts

@@ -130,7 +130,7 @@ export abstract class BaseOAuthProvider
 export class OAuthProvider extends BaseOAuthProvider {
   /**
    * Creates an {@link OAuthCredential} from a JSON string or a plain object.
-   * @param json A plain object or a JSON string
+   * @param json - A plain object or a JSON string
    */
   static credentialFromJSON(json: object | string): OAuthCredential {
     const obj = typeof json === 'string' ? JSON.parse(json) : json;

packages-exp/auth-exp/src/core/providers/saml.ts

@@ -36,7 +36,7 @@ const SAML_PROVIDER_PREFIX = 'saml.';
 export class SAMLAuthProvider extends FederatedAuthProvider {
   /**
    * Constructor. The providerId must start with "saml."
-   * @param - providerId
+   * @param providerId - SAML provider ID.
    */
   constructor(providerId: string) {
     _assert(
@@ -60,7 +60,7 @@ export class SAMLAuthProvider extends FederatedAuthProvider {
    * const credential = SAMLAuthProvider.credentialFromResult(userCredential);
    * ```
    *
-   * @param userCredential
+   * @param userCredential - The user credential.
    */
   static credentialFromResult(
     userCredential: UserCredential
@@ -84,7 +84,7 @@ export class SAMLAuthProvider extends FederatedAuthProvider {
 
   /**
    * Creates an {@link AuthCredential} from a JSON string or a plain object.
-   * @param json A plain object or a JSON string
+   * @param json - A plain object or a JSON string
    */
   static credentialFromJSON(json: string | object): AuthCredential {
     const credential = SAMLAuthCredential.fromJSON(json);

packages-exp/auth-exp/src/platform_browser/providers/phone.ts

@@ -150,7 +150,7 @@ export class PhoneAuthProvider {
 
   /**
    * Generates an {@link AuthCredential} from a {@link UserCredential}.
-   * @param userCredential
+   * @param userCredential - The user credential.
    */
   static credentialFromResult(
     userCredential: UserCredential
@@ -189,7 +189,7 @@ export class PhoneAuthProvider {
    * // At this point, auth.currentUser.phoneNumber === number.
    * ```
    *
-   * @param error
+   * @param error - The error to generate a credential from.
    */
   static credentialFromError(error: FirebaseError): AuthCredential | null {
     return PhoneAuthProvider.credentialFromTaggedObject(

packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha.ts

@@ -15,6 +15,10 @@
  * limitations under the License.
  */
 
+/**
+ * This needs a comment block or tsdoc will think the header comment
+ * is associated with this interface.
+ */
 export interface Parameters {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [key: string]: any;