Storage-exp: fix doc comments and remove namespace imports. (#4185)

Author: hsubox76

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

@@ -18,7 +18,17 @@ export interface ActionCodeInfo {
     multiFactorInfo?: MultiFactorInfo | null;
     previousEmail?: string | null;
   };
-  operation: Operation;
+  operation: ActionCodeOperation;
+}
+
+// @public
+export const enum ActionCodeOperation {
+  EMAIL_SIGNIN = 'EMAIL_SIGNIN',
+  PASSWORD_RESET = 'PASSWORD_RESET',
+  RECOVER_EMAIL = 'RECOVER_EMAIL',
+  REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION',
+  VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL',
+  VERIFY_EMAIL = 'VERIFY_EMAIL'
 }
 
 // @public
@@ -42,16 +52,16 @@ export abstract class ActionCodeURL {
   readonly code: string;
   readonly continueUrl: string | null;
   readonly languageCode: string | null;
-  readonly operation: Operation;
+  readonly operation: ActionCodeOperation;
   static parseLink(link: string): ActionCodeURL | null;
   readonly tenantId: string | null;
 }
 
 // @public
 export interface AdditionalUserInfo {
   readonly isNewUser: boolean;
-  readonly profile: UserProfile | null;
-  readonly providerId: ProviderId | null;
+  readonly profile: Record<string, unknown> | null;
+  readonly providerId: string | null;
   readonly username?: string | null;
 }
 
@@ -77,13 +87,13 @@ export interface Auth {
     error?: ErrorFn,
     completed?: CompleteFn
   ): Unsubscribe;
-  setPersistence(persistence: Persistence): void;
+  setPersistence(persistence: Persistence): Promise<void>;
   readonly settings: AuthSettings;
   signOut(): Promise<void>;
   tenantId: string | null;
   updateCurrentUser(user: User | null): Promise<void>;
   useDeviceLanguage(): void;
-  useEmulator(url: string): void;
+  useEmulator(url: string, options?: { disableWarnings: boolean }): void;
 }
 
 // @public
@@ -148,6 +158,11 @@ export abstract class EmailAuthProvider implements AuthProvider {
   readonly providerId: ProviderId;
 }
 
+// @public
+export const enum FactorId {
+  PHONE = 'phone'
+}
+
 // @public
 export interface IdTokenResult {
   authTime: string;
@@ -161,28 +176,27 @@ export interface IdTokenResult {
 
 // @public
 export interface MultiFactorAssertion {
-  readonly factorId: string;
+  readonly factorId: FactorId;
 }
 
 // @public
 export interface MultiFactorError extends AuthError {
-  readonly credential: AuthCredential;
   readonly operationType: OperationType;
 }
 
 // @public
 export interface MultiFactorInfo {
   readonly displayName?: string | null;
   readonly enrollmentTime: string;
-  readonly factorId: ProviderId;
+  readonly factorId: FactorId;
   readonly uid: string;
 }
 
 // @public
 export abstract class MultiFactorResolver {
-  hints: MultiFactorInfo[];
+  readonly hints: MultiFactorInfo[];
   resolveSignIn(assertion: MultiFactorAssertion): Promise<UserCredential>;
-  session: MultiFactorSession;
+  readonly session: MultiFactorSession;
 }
 
 // @public
@@ -213,16 +227,6 @@ export abstract class OAuthCredential extends AuthCredential {
   readonly secret?: string;
 }
 
-// @public
-export const enum Operation {
-  EMAIL_SIGNIN = 'EMAIL_SIGNIN',
-  PASSWORD_RESET = 'PASSWORD_RESET',
-  RECOVER_EMAIL = 'RECOVER_EMAIL',
-  REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION',
-  VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL',
-  VERIFY_EMAIL = 'VERIFY_EMAIL'
-}
-
 // @public
 export const enum OperationType {
   LINK = 'link',
@@ -390,7 +394,7 @@ export interface User extends UserInfo {
 // @public
 export interface UserCredential {
   operationType: OperationType;
-  providerId: ProviderId | null;
+  providerId: string | null;
   user: User;
 }
 

common/api-review/firestore.api.md

@@ -7,7 +7,7 @@
 import { FirebaseApp } from '@firebase/app-types-exp';
 import { LogLevelString as LogLevel } from '@firebase/logger';
 
-// @public (undocumented)
+// @public
 export function addDoc<T>(reference: CollectionReference<T>, data: T): Promise<DocumentReference<T>>;
 
 // @public

common/api-review/firestore.lite.api.md

@@ -7,7 +7,7 @@
 import { FirebaseApp } from '@firebase/app-types-exp';
 import { LogLevelString as LogLevel } from '@firebase/logger';
 
-// @public (undocumented)
+// @public
 export function addDoc<T>(reference: CollectionReference<T>, data: T): Promise<DocumentReference<T>>;
 
 // @public

common/api-review/storage-types.api.md

@@ -0,0 +1,156 @@
+## API Report File for "@firebase/storage-types"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { CompleteFn } from '@firebase/util';
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { FirebaseError } from '@firebase/util';
+import { NextFn } from '@firebase/util';
+import { Unsubscribe } from '@firebase/util';
+
+// @public
+export interface FirebaseStorageError extends FirebaseError {
+  serverResponse: string | null;
+}
+
+// @public
+export interface ListOptions {
+  maxResults?: number | null;
+  pageToken?: string | null;
+}
+
+// @public
+export interface ListResult {
+  items: StorageReference[];
+  nextPageToken?: string;
+  prefixes: StorageReference[];
+}
+
+// @public
+export interface Metadata {
+  // (undocumented)
+  [prop: string]: unknown;
+
+  bucket: string;
+
+  cacheControl: string | undefined;
+
+  contentDisposition: string | undefined;
+
+  contentEncoding: string | undefined;
+
+  contentLanguage: string | undefined;
+
+  contentType: string | undefined;
+
+  customMetadata:
+    | {
+        [key: string]: string;
+      }
+    | undefined;
+
+  downloadTokens: string[] | undefined;
+
+  fullPath: string;
+
+  generation: string;
+
+  md5Hash: string | undefined;
+
+  metageneration: string;
+
+  name: string;
+
+  ref: StorageReference | undefined;
+
+  size: number;
+
+  timeCreated: string;
+
+  updated: string;
+}
+
+// @public
+export interface StorageObserver<T> {
+  // (undocumented)
+  complete?: CompleteFn | null;
+  // (undocumented)
+  error?: (error: FirebaseStorageError) => void | null;
+  // (undocumented)
+  next?: NextFn<T> | null;
+}
+
+// @public
+export interface StorageReference {
+  bucket: string;
+  fullPath: string;
+  name: string;
+  parent: StorageReference | null;
+  root: StorageReference;
+  storage: StorageService;
+  toString(): string;
+}
+
+// @public
+export interface StorageService {
+  readonly app: FirebaseApp;
+  maxOperationRetryTime: number;
+  maxUploadRetryTime: number;
+}
+
+// @public
+export type TaskEvent = 'state_changed';
+
+// @public
+export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
+
+// @public
+export interface UploadResult {
+  readonly metadata: Metadata;
+
+  readonly ref: StorageReference;
+}
+
+// @public
+export interface UploadTask {
+  cancel(): boolean;
+  catch(onRejected: (error: FirebaseStorageError) => any): Promise<any>;
+  on(
+    event: TaskEvent,
+    nextOrObserver?:
+      | StorageObserver<UploadTaskSnapshot>
+      | null
+      | ((snapshot: UploadTaskSnapshot) => any),
+    error?: ((a: FirebaseStorageError) => any) | null,
+    complete?: Unsubscribe | null
+  ): Function;
+  pause(): boolean;
+  resume(): boolean;
+  snapshot: UploadTaskSnapshot;
+  then(
+    onFulfilled?: ((snapshot: UploadTaskSnapshot) => any) | null,
+    onRejected?: ((error: FirebaseStorageError) => any) | null
+  ): Promise<any>;
+}
+
+// @public
+export interface UploadTaskSnapshot {
+  bytesTransferred: number;
+
+  metadata: Metadata;
+
+  ref: StorageReference;
+
+  state: TaskState;
+
+  task: UploadTask;
+
+  totalBytes: number;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```