change StorageService to FirebaseStorage

Author: Feiyang1

common/api-review/storage.api.md

@@ -16,7 +16,7 @@ import { Subscribe } from '@firebase/util';
 import { Unsubscribe } from '@firebase/util';
 
 // @public
-export function connectStorageEmulator(storage: StorageService, host: string, port: number): void;
+export function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number): void;
 
 // @public
 export function deleteObject(ref: StorageReference): Promise<void>;
@@ -36,6 +36,13 @@ export class _FbsBlob {
     uploadData(): Blob | Uint8Array;
 }
 
+// @public
+export interface FirebaseStorage extends _FirebaseService {
+    readonly app: FirebaseApp;
+    maxOperationRetryTime: number;
+    maxUploadRetryTime: number;
+}
+
 // @public
 export interface FirebaseStorageError extends FirebaseError {
     serverResponse: string | null;
@@ -65,7 +72,7 @@ export function getDownloadURL(ref: StorageReference): Promise<string>;
 export function getMetadata(ref: StorageReference): Promise<FullMetadata>;
 
 // @public
-export function getStorage(app?: FirebaseApp, bucketUrl?: string): StorageService;
+export function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
 
 // @public
 export function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
@@ -106,25 +113,25 @@ export class _Location {
     }
 
 // @public
-export function ref(storage: StorageService, url?: string): StorageReference;
+export function ref(storage: FirebaseStorage, url?: string): StorageReference;
 
 // @public
-export function ref(storageOrRef: StorageService | StorageReference, path?: string): StorageReference;
+export function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
 
 // @internal
 export class _Reference {
-    // Warning: (ae-forgotten-export) The symbol "StorageService" needs to be exported by the entry point index.d.ts
-    constructor(_service: StorageService_2, location: string | _Location);
+    // Warning: (ae-forgotten-export) The symbol "FirebaseStorageImpl" needs to be exported by the entry point index.d.ts
+    constructor(_service: FirebaseStorageImpl, location: string | _Location);
     get bucket(): string;
     get fullPath(): string;
     // (undocumented)
     _location: _Location;
     get name(): string;
     // (undocumented)
-    protected _newRef(service: StorageService_2, location: _Location): _Reference;
+    protected _newRef(service: FirebaseStorageImpl, location: _Location): _Reference;
     get parent(): _Reference | null;
     get root(): _Reference;
-    get storage(): StorageService_2;
+    get storage(): FirebaseStorageImpl;
     _throwIfRoot(name: string): void;
     // @override
     toString(): string;
@@ -159,17 +166,10 @@ export interface StorageReference {
     name: string;
     parent: StorageReference | null;
     root: StorageReference;
-    storage: StorageService;
+    storage: FirebaseStorage;
     toString(): string;
 }
 
-// @public
-export interface StorageService extends _FirebaseService {
-    readonly app: FirebaseApp;
-    maxOperationRetryTime: number;
-    maxUploadRetryTime: number;
-}
-
 // @public
 export type StringFormat = string;
 

packages/storage/compat/service.ts

@@ -18,13 +18,14 @@
 import * as types from '@firebase/storage-types';
 import { FirebaseApp } from '@firebase/app-types';
 
-import { ref, _Location } from '../exp/api'; // import from the exp public API
-import { ReferenceCompat } from './reference';
 import {
-  isUrl,
-  StorageService,
-  connectStorageEmulator as internalUseEmulator
-} from '../src/service';
+  ref,
+  _Location,
+  connectStorageEmulator,
+  FirebaseStorage
+} from '../exp/api'; // import from the exp public API
+import { ReferenceCompat } from './reference';
+import { isUrl, FirebaseStorageImpl } from '../src/service';
 import { invalidArgument } from '../src/implementation/error';
 import { Compat } from '@firebase/util';
 
@@ -33,9 +34,9 @@ import { Compat } from '@firebase/util';
  * @param opt_url gs:// url to a custom Storage Bucket
  */
 export class StorageServiceCompat
-  implements types.FirebaseStorage, Compat<StorageService>
+  implements types.FirebaseStorage, Compat<FirebaseStorage>
 {
-  constructor(public app: FirebaseApp, readonly _delegate: StorageService) {}
+  constructor(public app: FirebaseApp, readonly _delegate: FirebaseStorage) {}
 
   INTERNAL = {
     /**
@@ -78,7 +79,7 @@ export class StorageServiceCompat
       );
     }
     try {
-      _Location.makeFromUrl(url, this._delegate.host);
+      _Location.makeFromUrl(url, (this._delegate as FirebaseStorageImpl).host);
     } catch (e) {
       throw invalidArgument(
         'refFromUrl() expected a valid full URL but got an invalid one.'
@@ -96,6 +97,6 @@ export class StorageServiceCompat
   }
 
   useEmulator(host: string, port: number): void {
-    internalUseEmulator(this._delegate, host, port);
+    connectStorageEmulator(this._delegate, host, port);
   }
 }

packages/storage/exp/api.ts

@@ -14,17 +14,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-import {
-  _getProvider,
-  FirebaseApp,
-  getApp
-  // eslint-disable-next-line import/no-extraneous-dependencies
-} from '@firebase/app-exp';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { _getProvider, FirebaseApp, getApp } from '@firebase/app-exp';
 
 import {
   ref as refInternal,
-  StorageService as StorageServiceInternal
+  FirebaseStorageImpl,
+  connectStorageEmulator as connectEmulatorInternal
 } from '../src/service';
 import { Provider } from '@firebase/component';
 
@@ -268,7 +264,7 @@ export function ref(
 ): StorageReference | null {
   serviceOrRef = getModularInstance(serviceOrRef);
   return refInternal(
-    serviceOrRef as StorageServiceInternal | Reference,
+    serviceOrRef as FirebaseStorageImpl | Reference,
     pathOrUrl
   );
 }
@@ -304,3 +300,19 @@ export function getStorage(
   });
   return storageInstance;
 }
+
+/**
+ * Modify this `StorageService` instance to communicate with the Cloud Storage emulator.
+ *
+ * @param storage - The `StorageService` instance
+ * @param host - The emulator host (ex: localhost)
+ * @param port - The emulator port (ex: 5001)
+ * @public
+ */
+export function connectStorageEmulator(
+  storage: FirebaseStorage,
+  host: string,
+  port: number
+): void {
+  connectEmulatorInternal(storage as FirebaseStorageImpl, host, port);
+}

packages/storage/exp/index.ts

@@ -20,19 +20,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
+// eslint-disable-next-line import/no-extraneous-dependencies
 import {
   _registerComponent,
   registerVersion,
   SDK_VERSION
-  // eslint-disable-next-line import/no-extraneous-dependencies
 } from '@firebase/app-exp';
 
 import { ConnectionPool } from '../src/implementation/connectionPool';
-import {
-  StorageService as StorageServiceInternal,
-  connectStorageEmulator as useEmulatorInternal
-} from '../src/service';
+import { FirebaseStorageImpl } from '../src/service';
 import {
   Component,
   ComponentType,
@@ -45,22 +41,6 @@ import { name, version } from '../package.json';
 import { FirebaseStorage } from './public-types';
 import { STORAGE_TYPE } from './constants';
 
-/**
- * Modify this `StorageService` instance to communicate with the Cloud Storage emulator.
- *
- * @param storage - The `StorageService` instance
- * @param host - The emulator host (ex: localhost)
- * @param port - The emulator port (ex: 5001)
- * @public
- */
-export function connectStorageEmulator(
-  storage: FirebaseStorage,
-  host: string,
-  port: number
-): void {
-  useEmulatorInternal(storage as StorageServiceInternal, host, port);
-}
-
 export { StringFormat } from '../src/implementation/string';
 export * from './api';
 
@@ -72,7 +52,7 @@ function factory(
   const authProvider = container.getProvider('auth-internal');
   const appCheckProvider = container.getProvider('app-check-internal');
 
-  return new StorageServiceInternal(
+  return new FirebaseStorageImpl(
     app,
     authProvider,
     appCheckProvider,

packages/storage/index.ts

@@ -23,7 +23,7 @@ import { TaskEvent, TaskState } from './src/implementation/taskenums';
 import { ConnectionPool } from './src/implementation/connectionPool';
 import { ReferenceCompat } from './compat/reference';
 import { StorageServiceCompat } from './compat/service';
-import { StorageService } from './src/service';
+import { FirebaseStorageImpl } from './src/service';
 import * as types from '@firebase/storage-types';
 import {
   Component,
@@ -55,7 +55,7 @@ function factory(
   // of creating a new one.
   const storageServiceCompat: StorageServiceCompat = new StorageServiceCompat(
     app,
-    new StorageService(
+    new FirebaseStorageImpl(
       app,
       authProvider,
       appCheckProvider,
@@ -73,7 +73,7 @@ export function registerStorage(instance: _FirebaseNamespace): void {
     TaskState,
     TaskEvent,
     StringFormat,
-    Storage: StorageService,
+    Storage: FirebaseStorageImpl,
     Reference: ReferenceCompat
   };
   instance.INTERNAL.registerComponent(

packages/storage/src/implementation/list.ts

@@ -21,7 +21,7 @@
 import { Location } from './location';
 import { jsonObjectOrNull } from './json';
 import { ListResult } from '../list';
-import { StorageService } from '../service';
+import { FirebaseStorageImpl } from '../service';
 
 /**
  * Represents the simplified object metadata returned by List API.
@@ -46,7 +46,7 @@ const PREFIXES_KEY = 'prefixes';
 const ITEMS_KEY = 'items';
 
 function fromBackendResponse(
-  service: StorageService,
+  service: FirebaseStorageImpl,
   bucket: string,
   resource: ListResultResponse
 ): ListResult {
@@ -77,14 +77,14 @@ function fromBackendResponse(
 }
 
 export function fromResponseString(
-  service: StorageService,
+  service: FirebaseStorageImpl,
   bucket: string,
   resourceString: string
 ): ListResult | null {
   const obj = jsonObjectOrNull(resourceString);
   if (obj === null) {
     return null;
   }
-  const resource = (obj as unknown) as ListResultResponse;
+  const resource = obj as unknown as ListResultResponse;
   return fromBackendResponse(service, bucket, resource);
 }

packages/storage/src/implementation/metadata.ts

@@ -26,7 +26,7 @@ import { lastComponent } from './path';
 import { isString } from './type';
 import { makeUrl, makeQueryString } from './url';
 import { Reference } from '../reference';
-import { StorageService } from '../service';
+import { FirebaseStorageImpl } from '../service';
 
 export function noXform_<T>(metadata: Metadata, value: T): T {
   return value;
@@ -111,7 +111,7 @@ export function getMappings(): Mappings {
   return mappings_;
 }
 
-export function addRef(metadata: Metadata, service: StorageService): void {
+export function addRef(metadata: Metadata, service: FirebaseStorageImpl): void {
   function generateRef(): Reference {
     const bucket: string = metadata['bucket'] as string;
     const path: string = metadata['fullPath'] as string;
@@ -122,7 +122,7 @@ export function addRef(metadata: Metadata, service: StorageService): void {
 }
 
 export function fromResource(
-  service: StorageService,
+  service: FirebaseStorageImpl,
   resource: { [name: string]: unknown },
   mappings: Mappings
 ): Metadata {
@@ -141,7 +141,7 @@ export function fromResource(
 }
 
 export function fromResourceString(
-  service: StorageService,
+  service: FirebaseStorageImpl,
   resourceString: string,
   mappings: Mappings
 ): Metadata | null {