Expose only public types from Auth exp (#4398)

* remove unnecessary internal annotation

* swap in the public typings when doing release build

Author: Feiyang1

packages-exp/auth-exp/api-extractor.json

@@ -1,5 +1,10 @@
 {
     "extends": "../../config/api-extractor.json",
     // Point it to your entry point d.ts file. 
-    "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts"
+    "mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.d.ts",
+    "dtsRollup": {
+        "enabled": true,
+        "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
+        "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
+    }
 }

packages-exp/auth-exp/package.json

@@ -17,7 +17,7 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c && yarn api-report",
     "build:deps": "lerna run --scope @firebase/auth-exp --include-dependencies build",
-    "build:release": "rollup -c rollup.config.release.js",
+    "build:release": "rollup -c rollup.config.release.js && yarn api-report && yarn typings:public",
     "dev": "rollup -c -w",
     "test": "run-p lint test:all",
     "test:all": "run-p test:browser test:node",
@@ -31,7 +31,8 @@
     "api-report": "api-extractor run --local --verbose",
     "predoc": "node ../../scripts/exp/remove-exp.js temp",
     "doc": "api-documenter markdown --input temp --output docs",
-    "build:doc": "yarn build && yarn doc"
+    "build:doc": "yarn build && yarn doc",
+    "typings:public": "node ../../scripts/exp/use_typings.js ./dist/auth-exp-public.d.ts"
   },
   "peerDependencies": {
     "@firebase/app-exp": "0.x",

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

@@ -23,7 +23,6 @@ import { _assert } from './util/assert';
  * Enums for fields in URL query string.
  *
  * @enum {string}
- * @internal
  */
 const enum QueryField {
   API_KEY = 'apiKey',
@@ -38,7 +37,6 @@ const enum QueryField {
  * Maps the mode string in action code URL to Action Code Info operation.
  *
  * @param mode
- * @internal
  */
 function parseMode(mode: string | null): externs.ActionCodeOperation | null {
   switch (mode) {
@@ -63,7 +61,6 @@ function parseMode(mode: string | null): externs.ActionCodeOperation | null {
  * Helper to parse FDL links
  *
  * @param url
- * @internal
  */
 function parseDeepLink(url: string): string {
   const uri = new URL(url);

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

@@ -30,9 +30,6 @@ import { AuthCredential } from './auth_credential';
 
 const IDP_REQUEST_URI = 'http://localhost';
 
-/**
- * @internal
- */
 export interface OAuthCredentialParams {
   // OAuth 2 uses either id token or access token
   idToken?: string | null;

packages-exp/auth-exp/src/core/credentials/phone.ts

@@ -28,7 +28,6 @@ import { Auth } from '../../model/auth';
 import { IdTokenResponse } from '../../model/id_token';
 import { AuthCredential } from './auth_credential';
 
-/** @internal */
 export interface PhoneAuthCredentialParameters {
   verificationId?: string;
   verificationCode?: string;

packages-exp/auth-exp/src/core/strategies/credential.ts

@@ -27,7 +27,6 @@ import { _reauthenticate } from '../user/reauthenticate';
 import { UserCredentialImpl } from '../user/user_credential_impl';
 import { _castAuth } from '../auth/auth_impl';
 
-/** @internal */
 export async function _signInWithCredential(
   auth: Auth,
   credential: AuthCredential,

packages-exp/auth-exp/src/core/strategies/idp.ts

@@ -31,7 +31,6 @@ import { _assert } from '../util/assert';
 import { _signInWithCredential } from './credential';
 import { AuthErrorCode } from '../errors';
 
-/** @internal */
 export interface IdpTaskParams {
   auth: Auth;
   requestUri: string;
@@ -43,10 +42,8 @@ export interface IdpTaskParams {
   bypassAuthState?: boolean;
 }
 
-/** @internal */
 export type IdpTask = (params: IdpTaskParams) => Promise<UserCredential>;
 
-/** @internal */
 class IdpCredential extends AuthCredential {
   constructor(readonly params: IdpTaskParams) {
     super(externs.ProviderId.CUSTOM, externs.ProviderId.CUSTOM);
@@ -83,7 +80,6 @@ class IdpCredential extends AuthCredential {
   }
 }
 
-/** @internal */
 export function _signIn(params: IdpTaskParams): Promise<UserCredential> {
   return _signInWithCredential(
     params.auth,
@@ -92,7 +88,6 @@ export function _signIn(params: IdpTaskParams): Promise<UserCredential> {
   ) as Promise<UserCredential>;
 }
 
-/** @internal */
 export function _reauth(params: IdpTaskParams): Promise<UserCredential> {
   const { auth, user } = params;
   _assert(user, auth, AuthErrorCode.INTERNAL_ERROR);
@@ -103,7 +98,6 @@ export function _reauth(params: IdpTaskParams): Promise<UserCredential> {
   );
 }
 
-/** @internal */
 export async function _link(params: IdpTaskParams): Promise<UserCredential> {
   const { auth, user } = params;
   _assert(user, auth, AuthErrorCode.INTERNAL_ERROR);

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

@@ -117,7 +117,6 @@ export function updatePassword(
   return updateEmailOrPassword(user as User, null, newPassword);
 }
 
-/** @internal */
 async function updateEmailOrPassword(
   user: User,
   email: string | null,

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

@@ -23,7 +23,6 @@ import { UserCredential } from '../../model/user';
 /**
  * Parse the `AdditionalUserInfo` from the ID token response.
  *
- * @internal
  */
 export function _fromIdTokenResponse(
   idTokenResponse?: IdTokenResponse

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

@@ -94,7 +94,6 @@ function secondsStringToMilliseconds(seconds: string): number {
   return Number(seconds) * 1000;
 }
 
-/** @internal */
 export function _parseToken(token: string): externs.ParsedToken | null {
   const [algorithm, payload, signature] = token.split('.');
   if (
@@ -121,8 +120,6 @@ export function _parseToken(token: string): externs.ParsedToken | null {
 
 /**
  * Extract expiresIn TTL from a token by subtracting the expiration from the issuance.
- *
- * @internal
  */
 export function _tokenExpiresIn(token: string): number {
   const parsedToken = _parseToken(token);

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

@@ -59,7 +59,6 @@ export async function unlink(
   return user;
 }
 
-/** @internal */
 export async function _link(
   user: User,
   credential: AuthCredential,
@@ -77,7 +76,6 @@ export async function _link(
   );
 }
 
-/** @internal */
 export async function _assertLinkedStatus(
   expected: boolean,
   user: User,

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

@@ -27,8 +27,6 @@ import { _tokenExpiresIn } from './id_token_result';
 /**
  * The number of milliseconds before the official expiration time of a token
  * to refresh that token, to provide a buffer for RPCs to complete.
- *
- * @internal
  */
 export const enum Buffer {
   TOKEN_REFRESH = 30_000

packages-exp/auth-exp/src/core/util/resolver.ts

@@ -26,8 +26,6 @@ import { _getInstance } from './instantiator';
  * Chooses a popup/redirect resolver to use. This prefers the override (which
  * is directly passed in), and falls back to the property set on the auth
  * object. If neither are available, this function errors w/ an argument error.
- *
- * @internal
  */
 export function _withDefaultResolver(
   auth: Auth,

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

@@ -17,8 +17,9 @@
 
 import * as externs from '@firebase/auth-types-exp';
 
-/** @internal */
 export interface ApplicationVerifier extends externs.ApplicationVerifier {
-  /** @internal */
+  /**
+   * @internal
+   */
   _reset(): void;
 }

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

@@ -22,76 +22,49 @@ import { AuthErrorCode, AuthErrorParams } from '../core/errors';
 import { PopupRedirectResolver } from './popup_redirect';
 import { User } from './user';
 
-/** @internal */
 export type AppName = string;
-/** @internal */
 export type ApiKey = string;
-/** @internal */
 export type AuthDomain = string;
 
-/** @internal */
 export interface ConfigInternal extends externs.Config {
   /**
-   * @internal
    * @readonly
    */
   emulator?: {
     url: string;
   };
 }
 
-/** @internal */
 export interface Auth extends externs.Auth {
-  /** @internal */
   currentUser: externs.User | null;
-  /** @internal */
   _canInitEmulator: boolean;
-  /** @internal */
   _isInitialized: boolean;
-  /** @internal */
   _initializationPromise: Promise<void> | null;
-  /** @internal */
   _updateCurrentUser(user: User | null): Promise<void>;
 
-  /** @internal */
   _onStorageEvent(): void;
 
-  /** @internal */
   _notifyListenersIfCurrent(user: User): void;
-  /** @internal */
   _persistUserIfCurrent(user: User): Promise<void>;
-  /** @internal */
   _setRedirectUser(
     user: User | null,
     popupRedirectResolver?: externs.PopupRedirectResolver
   ): Promise<void>;
-  /** @internal */
   _redirectUserForId(id: string): Promise<User | null>;
-  /** @internal */
   _popupRedirectResolver: PopupRedirectResolver | null;
-  /** @internal */
   _key(): string;
-  /** @internal */
   _startProactiveRefresh(): void;
-  /** @internal */
   _stopProactiveRefresh(): void;
   _getPersistence(): string;
 
-  /** @internal */
   readonly name: AppName;
-  /** @internal */
   readonly config: ConfigInternal;
-  /** @internal */
   languageCode: string | null;
-  /** @internal */
   tenantId: string | null;
-  /** @internal */
   readonly settings: externs.AuthSettings;
   _errorFactory: ErrorFactory<AuthErrorCode, AuthErrorParams>;
 
-  /** @internal */
   useDeviceLanguage(): void;
-  /** @internal */
   signOut(): Promise<void>;
 }
 

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

@@ -22,14 +22,12 @@ import { PhoneOrOauthTokenResponse } from '../api/authentication/mfa';
 /**
  * Raw encoded JWT
  *
- * @internal
  */
 export type IdToken = string;
 
 /**
  * Raw parsed JWT
  *
- * @internal
  */
 export interface ParsedIdToken {
   iss: string;
@@ -51,7 +49,6 @@ export interface ParsedIdToken {
 /**
  * IdToken as returned by the API
  *
- * @internal
  */
 export interface IdTokenResponse {
   localId: string;
@@ -72,7 +69,6 @@ export interface IdTokenResponse {
 /**
  * The possible types of the `IdTokenResponse`
  *
- * @internal
  */
 export const enum IdTokenResponseKind {
   CreateAuthUri = 'identitytoolkit#CreateAuthUriResponse',
@@ -91,9 +87,6 @@ export const enum IdTokenResponseKind {
   VerifyPassword = 'identitytoolkit#VerifyPasswordResponse'
 }
 
-/**
- * @internal
- */
 export interface TaggedWithTokenResponse {
   _tokenResponse?: PhoneOrOauthTokenResponse;
 }