exclude internal types from appearing in the public typings file (#4821)

Author: Feiyang1

packages-exp/auth-exp/src/core/user/token_manager.ts

@@ -32,6 +32,12 @@ export const enum Buffer {
   TOKEN_REFRESH = 30_000
 }
 
+/**
+ * We need to mark this class as internal explicitly to exclude it in the public typings, because
+ * it references AuthInternal which has a circular dependency with UserInternal.
+ *
+ * @internal
+ */
 export class StsTokenManager {
   refreshToken: string | null = null;
   accessToken: string | null = null;

packages-exp/auth-exp/src/model/auth.ts

@@ -48,6 +48,12 @@ export interface ConfigInternal extends Config {
   clientPlatform: ClientPlatform;
 }
 
+/**
+ * UserInternal and AuthInternal reference each other, so both of them are included in the public typings.
+ * In order to exclude them, we mark them as internal explicitly.
+ *
+ * @internal
+ */
 export interface AuthInternal extends Auth {
   currentUser: User | null;
   emulatorConfig: EmulatorConfig | null;

packages-exp/auth-exp/src/model/popup_redirect.ts

@@ -79,6 +79,12 @@ export interface EventManager {
   unregisterConsumer(authEventConsumer: AuthEventConsumer): void;
 }
 
+/**
+ * We need to mark this interface as internal explicitly to exclude it in the public typings, because
+ * it references AuthInternal which has a circular dependency with UserInternal.
+ *
+ * @internal
+ */
 export interface PopupRedirectResolverInternal extends PopupRedirectResolver {
   // Whether or not to initialize the event manager early
   _shouldInitProactively: boolean;

packages-exp/auth-exp/src/model/user.ts

@@ -52,6 +52,12 @@ export interface UserParameters {
   lastLoginAt?: string | null;
 }
 
+/**
+ * UserInternal and AuthInternal reference each other, so both of them are included in the public typings.
+ * In order to exclude them, we mark them as internal explicitly.
+ *
+ * @internal
+ */
 export interface UserInternal extends User {
   displayName: string | null;
   email: string | null;

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

@@ -32,6 +32,12 @@ export const _JSLOAD_CALLBACK = jsHelpers._generateCallbackName('rcb');
 const NETWORK_TIMEOUT_DELAY = new Delay(30000, 60000);
 const RECAPTCHA_BASE = 'https://www.google.com/recaptcha/api.js?';
 
+/**
+ * We need to mark this interface as internal explicitly to exclude it in the public typings, because
+ * it references AuthInternal which has a circular dependency with UserInternal.
+ *
+ * @internal
+ */
 export interface ReCaptchaLoader {
   load(auth: AuthInternal, hl?: string): Promise<Recaptcha>;
   clearedOneInstance(): void;