@depup/firebase__storage 0.14.1-depup.0

package/dist/node-esm/src/service.d.ts

@@ -0,0 +1,131 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Location } from './implementation/location';
+import { Request } from './implementation/request';
+import { RequestInfo } from './implementation/requestinfo';
+import { Reference } from './reference';
+import { Provider } from '@firebase/component';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { FirebaseApp } from '@firebase/app';
+import { FirebaseStorage } from './public-types';
+import { EmulatorMockTokenOptions } from '@firebase/util';
+import { Connection, ConnectionType } from './implementation/connection';
+export declare function isUrl(path?: string): boolean;
+/**
+ * Returns a storage Reference for the given url.
+ * @param storage - `Storage` instance.
+ * @param url - URL. If empty, returns root reference.
+ * @public
+ */
+export declare function ref(storage: FirebaseStorageImpl, url?: string): Reference;
+/**
+ * Returns a storage Reference for the given path in the
+ * default bucket.
+ * @param storageOrRef - `Storage` service or storage `Reference`.
+ * @param pathOrUrlStorage - path. If empty, returns root reference (if Storage
+ * instance provided) or returns same reference (if Reference provided).
+ * @public
+ */
+export declare function ref(storageOrRef: FirebaseStorageImpl | Reference, path?: string): Reference;
+export declare function connectStorageEmulator(storage: FirebaseStorageImpl, host: string, port: number, options?: {
+    mockUserToken?: EmulatorMockTokenOptions | string;
+}): void;
+/**
+ * A service that provides Firebase Storage Reference instances.
+ * @param opt_url - gs:// url to a custom Storage Bucket
+ *
+ * @internal
+ */
+export declare class FirebaseStorageImpl implements FirebaseStorage {
+    /**
+     * FirebaseApp associated with this StorageService instance.
+     */
+    readonly app: FirebaseApp;
+    readonly _authProvider: Provider<FirebaseAuthInternalName>;
+    /**
+     * @internal
+     */
+    readonly _appCheckProvider: Provider<AppCheckInternalComponentName>;
+    /**
+     * @internal
+     */
+    readonly _url?: string | undefined;
+    readonly _firebaseVersion?: string | undefined;
+    _isUsingEmulator: boolean;
+    _bucket: Location | null;
+    /**
+     * This string can be in the formats:
+     * - host
+     * - host:port
+     */
+    private _host;
+    _protocol: string;
+    protected readonly _appId: string | null;
+    private readonly _requests;
+    private _deleted;
+    private _maxOperationRetryTime;
+    private _maxUploadRetryTime;
+    _overrideAuthToken?: string;
+    constructor(
+    /**
+     * FirebaseApp associated with this StorageService instance.
+     */
+    app: FirebaseApp, _authProvider: Provider<FirebaseAuthInternalName>, 
+    /**
+     * @internal
+     */
+    _appCheckProvider: Provider<AppCheckInternalComponentName>, 
+    /**
+     * @internal
+     */
+    _url?: string | undefined, _firebaseVersion?: string | undefined, _isUsingEmulator?: boolean);
+    /**
+     * The host string for this service, in the form of `host` or
+     * `host:port`.
+     */
+    get host(): string;
+    set host(host: string);
+    /**
+     * The maximum time to retry uploads in milliseconds.
+     */
+    get maxUploadRetryTime(): number;
+    set maxUploadRetryTime(time: number);
+    /**
+     * The maximum time to retry operations other than uploads or downloads in
+     * milliseconds.
+     */
+    get maxOperationRetryTime(): number;
+    set maxOperationRetryTime(time: number);
+    _getAuthToken(): Promise<string | null>;
+    _getAppCheckToken(): Promise<string | null>;
+    /**
+     * Stop running requests and prevent more from being created.
+     */
+    _delete(): Promise<void>;
+    /**
+     * Returns a new firebaseStorage.Reference object referencing this StorageService
+     * at the given Location.
+     */
+    _makeStorageReference(loc: Location): Reference;
+    /**
+     * @param requestInfo - HTTP RequestInfo object
+     * @param authToken - Firebase auth token
+     */
+    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null, retry?: boolean): Request<O>;
+    makeRequestWithTokens<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>): Promise<O>;
+}

package/dist/node-esm/src/task.d.ts

@@ -0,0 +1,148 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @fileoverview Defines types for interacting with blob transfer tasks.
+ */
+import { FbsBlob } from './implementation/blob';
+import { StorageError } from './implementation/error';
+import { InternalTaskState, TaskEvent } from './implementation/taskenums';
+import { Metadata } from './metadata';
+import { Subscribe, Unsubscribe } from './implementation/observer';
+import { UploadTaskSnapshot, StorageObserver } from './public-types';
+import { Reference } from './reference';
+import { CompleteFn } from '@firebase/util';
+/**
+ * Represents a blob being uploaded. Can be used to pause/resume/cancel the
+ * upload and manage callbacks for various events.
+ * @internal
+ */
+export declare class UploadTask {
+    private _ref;
+    /**
+     * The data to be uploaded.
+     */
+    _blob: FbsBlob;
+    /**
+     * Metadata related to the upload.
+     */
+    _metadata: Metadata | null;
+    private _mappings;
+    /**
+     * Number of bytes transferred so far.
+     */
+    _transferred: number;
+    private _needToFetchStatus;
+    private _needToFetchMetadata;
+    private _observers;
+    private _resumable;
+    /**
+     * Upload state.
+     */
+    _state: InternalTaskState;
+    private _error?;
+    private _uploadUrl?;
+    private _request?;
+    private _chunkMultiplier;
+    private _errorHandler;
+    private _metadataErrorHandler;
+    private _resolve?;
+    private _reject?;
+    private pendingTimeout?;
+    private _promise;
+    private sleepTime;
+    private maxSleepTime;
+    isExponentialBackoffExpired(): boolean;
+    /**
+     * @param ref - The firebaseStorage.Reference object this task came
+     *     from, untyped to avoid cyclic dependencies.
+     * @param blob - The blob to upload.
+     */
+    constructor(ref: Reference, blob: FbsBlob, metadata?: Metadata | null);
+    private _makeProgressCallback;
+    private _shouldDoResumable;
+    private _start;
+    private _resolveToken;
+    private _createResumable;
+    private _fetchStatus;
+    private _continueUpload;
+    private _increaseMultiplier;
+    private _fetchMetadata;
+    private _oneShotUpload;
+    private _updateProgress;
+    private _transition;
+    private completeTransitions_;
+    /**
+     * A snapshot of the current task state.
+     */
+    get snapshot(): UploadTaskSnapshot;
+    /**
+     * Adds a callback for an event.
+     * @param type - The type of event to listen for.
+     * @param nextOrObserver -
+     *     The `next` function, which gets called for each item in
+     *     the event stream, or an observer object with some or all of these three
+     *     properties (`next`, `error`, `complete`).
+     * @param error - A function that gets called with a `StorageError`
+     *     if the event stream ends due to an error.
+     * @param completed - A function that gets called if the
+     *     event stream ends normally.
+     * @returns
+     *     If only the event argument is passed, returns a function you can use to
+     *     add callbacks (see the examples above). If more than just the event
+     *     argument is passed, returns a function you can call to unregister the
+     *     callbacks.
+     */
+    on(type: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, completed?: CompleteFn | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
+    /**
+     * This object behaves like a Promise, and resolves with its snapshot data
+     * when the upload completes.
+     * @param onFulfilled - The fulfillment callback. Promise chaining works as normal.
+     * @param onRejected - The rejection callback.
+     */
+    then<U>(onFulfilled?: ((value: UploadTaskSnapshot) => U | Promise<U>) | null, onRejected?: ((error: StorageError) => U | Promise<U>) | null): Promise<U>;
+    /**
+     * Equivalent to calling `then(null, onRejected)`.
+     */
+    catch<T>(onRejected: (p1: StorageError) => T | Promise<T>): Promise<T>;
+    /**
+     * Adds the given observer.
+     */
+    private _addObserver;
+    /**
+     * Removes the given observer.
+     */
+    private _removeObserver;
+    private _notifyObservers;
+    private _finishPromise;
+    private _notifyObserver;
+    /**
+     * Resumes a paused task. Has no effect on a currently running or failed task.
+     * @returns True if the operation took effect, false if ignored.
+     */
+    resume(): boolean;
+    /**
+     * Pauses a currently running task. Has no effect on a paused or failed task.
+     * @returns True if the operation took effect, false if ignored.
+     */
+    pause(): boolean;
+    /**
+     * Cancels a currently running or paused task. Has no effect on a complete or
+     * failed task.
+     * @returns True if the operation took effect, false if ignored.
+     */
+    cancel(): boolean;
+}

package/dist/node-esm/test/unit/connection.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ErrorCode, Headers, Connection } from '../../src/implementation/connection';
+export type SendHook = (connection: TestingConnection, url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers) => void;
+export declare enum State {
+    START = 0,
+    SENT = 1,
+    DONE = 2
+}
+export declare class TestingConnection implements Connection<string> {
+    private state;
+    private sendPromise;
+    private resolve;
+    private sendHook;
+    private status;
+    private responseText;
+    private headers;
+    private errorCode;
+    constructor(sendHook: SendHook | null);
+    send(url: string, method: string, _isUsingEmulator: boolean, body?: ArrayBufferView | Blob | string | null, headers?: Headers): Promise<void>;
+    simulateResponse(status: number, body: string, headers: {
+        [key: string]: string;
+    }): void;
+    getErrorCode(): ErrorCode;
+    getStatus(): number;
+    getResponse(): string;
+    getErrorText(): string;
+    abort(): void;
+    getResponseHeader(header: string): string | null;
+    addUploadProgressListener(): void;
+    removeUploadProgressListener(): void;
+}
+export declare function newTestConnection(sendHook?: SendHook | null): Connection<string>;

package/dist/node-esm/test/unit/testshared.d.ts

@@ -0,0 +1,60 @@
+import { FirebaseApp } from '@firebase/app-types';
+import { StorageError } from '../../src/implementation/error';
+import { Headers, Connection, ConnectionType } from '../../src/implementation/connection';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { FirebaseStorageImpl } from '../../src/service';
+import { Metadata } from '../../src/metadata';
+export declare const authToken = "totally-legit-auth-token";
+export declare const appCheckToken = "totally-shady-token";
+export declare const bucket = "mybucket";
+export declare const fakeApp: FirebaseApp;
+export declare const fakeAuthProvider: Provider<"auth-internal">;
+export declare const emptyAuthProvider: Provider<"auth-internal">;
+export declare const fakeAppCheckTokenProvider: Provider<"app-check-internal">;
+export declare function makeFakeApp(bucketArg?: string): FirebaseApp;
+export declare function makeFakeAuthProvider(token: {
+    accessToken: string;
+}): Provider<FirebaseAuthInternalName>;
+export declare function makeFakeAppCheckProvider(tokenResult: {
+    token: string;
+}): Provider<AppCheckInternalComponentName>;
+/**
+ * Returns something that looks like an fbs.XhrIo with the given headers
+ * and status.
+ */
+export declare function fakeXhrIo<I extends ConnectionType = string>(headers: Headers, status?: number): Connection<I>;
+/**
+ * Binds ignoring types. Used to test calls involving improper arguments.
+ */
+export declare function bind(f: Function, ctx: any, ...args: any[]): () => void;
+export declare function assertThrows(f: () => void, code: string): StorageError;
+export declare function assertUint8ArrayEquals(arr1: Uint8Array, arr2: Uint8Array): void;
+export declare function assertObjectIncludes(included: {
+    [name: string]: any;
+}, obj: {
+    [name: string]: any;
+}): void;
+interface Response {
+    status: number;
+    body: string;
+    headers: Headers;
+}
+export type RequestHandler = (url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers) => Response;
+export declare function storageServiceWithHandler(handler: RequestHandler, shouldResponseCb?: () => boolean): FirebaseStorageImpl;
+export declare function fakeServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+/**
+ * Responds with a 503 for finalize.
+ * @param fakeMetadata metadata to respond with for finalize
+ * @returns a handler for requests
+ */
+export declare function fake503ForFinalizeServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+/**
+ * Responds with a 503 for upload.
+ * @param fakeMetadata metadata to respond with for query
+ * @returns a handler for requests
+ */
+export declare function fake503ForUploadServerHandler(fakeMetadata?: Partial<Metadata>, cb?: () => void): RequestHandler;
+export declare function fakeOneShot503ServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+export {};

package/dist/src/api.browser.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { StorageReference } from './public-types';
+/**
+ * Downloads the data at the object's location. Returns an error if the object
+ * is not found.
+ *
+ * To use this functionality, you have to whitelist your app's origin in your
+ * Cloud Storage bucket. See also
+ * https://cloud.google.com/storage/docs/configuring-cors
+ *
+ * This API is not available in Node.
+ *
+ * @public
+ * @param ref - StorageReference where data should be downloaded.
+ * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
+ * retrieve.
+ * @returns A Promise that resolves with a Blob containing the object's bytes
+ */
+export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
+/**
+ * Downloads the data at the object's location. Raises an error event if the
+ * object is not found.
+ *
+ * This API is only available in Node.
+ *
+ * @public
+ * @param ref - StorageReference where data should be downloaded.
+ * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
+ * retrieve.
+ * @returns A stream with the object's data as bytes
+ */
+export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;

package/dist/src/api.d.ts

@@ -0,0 +1,200 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FirebaseApp } from '@firebase/app';
+import { StorageReference, FirebaseStorage, UploadResult, ListOptions, ListResult, UploadTask, SettableMetadata, UploadMetadata, FullMetadata } from './public-types';
+import { Reference } from './reference';
+import { EmulatorMockTokenOptions } from '@firebase/util';
+import { StringFormat } from './implementation/string';
+export { EmulatorMockTokenOptions } from '@firebase/util';
+export { StorageError, StorageErrorCode } from './implementation/error';
+/**
+ * Public types.
+ */
+export * from './public-types';
+export { Location as _Location } from './implementation/location';
+export { UploadTask as _UploadTask } from './task';
+export type { Reference as _Reference } from './reference';
+export type { FirebaseStorageImpl as _FirebaseStorageImpl } from './service';
+export { FbsBlob as _FbsBlob } from './implementation/blob';
+export { dataFromString as _dataFromString } from './implementation/string';
+export { invalidRootOperation as _invalidRootOperation, invalidArgument as _invalidArgument } from './implementation/error';
+export { TaskEvent as _TaskEvent, TaskState as _TaskState } from './implementation/taskenums';
+export { StringFormat };
+/**
+ * Downloads the data at the object's location. Returns an error if the object
+ * is not found.
+ *
+ * To use this functionality, you have to whitelist your app's origin in your
+ * Cloud Storage bucket. See also
+ * https://cloud.google.com/storage/docs/configuring-cors
+ *
+ * @public
+ * @param ref - StorageReference where data should be downloaded.
+ * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
+ * retrieve.
+ * @returns A Promise containing the object's bytes
+ */
+export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
+/**
+ * Uploads data to this object's location.
+ * The upload is not resumable.
+ * @public
+ * @param ref - {@link StorageReference} where data should be uploaded.
+ * @param data - The data to upload.
+ * @param metadata - Metadata for the data to upload.
+ * @returns A Promise containing an UploadResult
+ */
+export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
+/**
+ * Uploads a string to this object's location.
+ * The upload is not resumable.
+ * @public
+ * @param ref - {@link StorageReference} where string should be uploaded.
+ * @param value - The string to upload.
+ * @param format - The format of the string to upload.
+ * @param metadata - Metadata for the string to upload.
+ * @returns A Promise containing an UploadResult
+ */
+export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
+/**
+ * Uploads data to this object's location.
+ * The upload can be paused and resumed, and exposes progress updates.
+ * @public
+ * @param ref - {@link StorageReference} where data should be uploaded.
+ * @param data - The data to upload.
+ * @param metadata - Metadata for the data to upload.
+ * @returns An UploadTask
+ */
+export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
+/**
+ * A `Promise` that resolves with the metadata for this object. If this
+ * object doesn't exist or metadata cannot be retrieved, the promise is
+ * rejected.
+ * @public
+ * @param ref - {@link StorageReference} to get metadata from.
+ */
+export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
+/**
+ * Updates the metadata for this object.
+ * @public
+ * @param ref - {@link StorageReference} to update metadata for.
+ * @param metadata - The new metadata for the object.
+ *     Only values that have been explicitly set will be changed. Explicitly
+ *     setting a value to null will remove the metadata.
+ * @returns A `Promise` that resolves with the new metadata for this object.
+ */
+export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
+/**
+ * List items (files) and prefixes (folders) under this storage reference.
+ *
+ * List API is only available for Firebase Rules Version 2.
+ *
+ * GCS is a key-blob store. Firebase Storage imposes the semantic of '/'
+ * delimited folder structure.
+ * Refer to GCS's List API if you want to learn more.
+ *
+ * To adhere to Firebase Rules's Semantics, Firebase Storage does not
+ * support objects whose paths end with "/" or contain two consecutive
+ * "/"s. Firebase Storage List API will filter these unsupported objects.
+ * list() may fail if there are too many unsupported objects in the bucket.
+ * @public
+ *
+ * @param ref - {@link StorageReference} to get list from.
+ * @param options - See {@link ListOptions} for details.
+ * @returns A `Promise` that resolves with the items and prefixes.
+ *      `prefixes` contains references to sub-folders and `items`
+ *      contains references to objects in this folder. `nextPageToken`
+ *      can be used to get the rest of the results.
+ */
+export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
+/**
+ * List all items (files) and prefixes (folders) under this storage reference.
+ *
+ * This is a helper method for calling list() repeatedly until there are
+ * no more results. The default pagination size is 1000.
+ *
+ * Note: The results may not be consistent if objects are changed while this
+ * operation is running.
+ *
+ * Warning: `listAll` may potentially consume too many resources if there are
+ * too many results.
+ * @public
+ * @param ref - {@link StorageReference} to get list from.
+ *
+ * @returns A `Promise` that resolves with all the items and prefixes under
+ *      the current storage reference. `prefixes` contains references to
+ *      sub-directories and `items` contains references to objects in this
+ *      folder. `nextPageToken` is never returned.
+ */
+export declare function listAll(ref: StorageReference): Promise<ListResult>;
+/**
+ * Returns the download URL for the given {@link StorageReference}.
+ * @public
+ * @param ref - {@link StorageReference} to get the download URL for.
+ * @returns A `Promise` that resolves with the download
+ *     URL for this object.
+ */
+export declare function getDownloadURL(ref: StorageReference): Promise<string>;
+/**
+ * Deletes the object at this location.
+ * @public
+ * @param ref - {@link StorageReference} for object to delete.
+ * @returns A `Promise` that resolves if the deletion succeeds.
+ */
+export declare function deleteObject(ref: StorageReference): Promise<void>;
+/**
+ * Returns a {@link StorageReference} for the given url.
+ * @param storage - {@link FirebaseStorage} instance.
+ * @param url - URL. If empty, returns root reference.
+ * @public
+ */
+export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
+/**
+ * Returns a {@link StorageReference} for the given path in the
+ * default bucket.
+ * @param storageOrRef - {@link FirebaseStorage} or {@link StorageReference}.
+ * @param pathOrUrlStorage - path. If empty, returns root reference (if {@link FirebaseStorage}
+ * instance provided) or returns same reference (if {@link StorageReference} provided).
+ * @public
+ */
+export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
+/**
+ * @internal
+ */
+export declare function _getChild(ref: StorageReference, childPath: string): Reference;
+/**
+ * Gets a {@link FirebaseStorage} instance for the given Firebase app.
+ * @public
+ * @param app - Firebase app to get {@link FirebaseStorage} instance for.
+ * @param bucketUrl - The gs:// url to your Firebase Storage Bucket.
+ * If not passed, uses the app's default Storage Bucket.
+ * @returns A {@link FirebaseStorage} instance.
+ */
+export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
+/**
+ * Modify this {@link FirebaseStorage} instance to communicate with the Cloud Storage emulator.
+ *
+ * @param storage - The {@link FirebaseStorage} instance
+ * @param host - The emulator host (ex: localhost)
+ * @param port - The emulator port (ex: 5001)
+ * @param options - Emulator options. `options.mockUserToken` is the mock auth
+ * token to use for unit testing Security Rules.
+ * @public
+ */
+export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
+    mockUserToken?: EmulatorMockTokenOptions | string;
+}): void;

package/dist/src/api.node.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { StorageReference } from './public-types';
+/**
+ * Downloads the data at the object's location. Returns an error if the object
+ * is not found.
+ *
+ * To use this functionality, you have to whitelist your app's origin in your
+ * Cloud Storage bucket. See also
+ * https://cloud.google.com/storage/docs/configuring-cors
+ *
+ * This API is not available in Node.
+ *
+ * @public
+ * @param ref - StorageReference where data should be downloaded.
+ * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
+ * retrieve.
+ * @returns A Promise that resolves with a Blob containing the object's bytes
+ */
+export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
+/**
+ * Downloads the data at the object's location. Raises an error event if the
+ * object is not found.
+ *
+ * This API is only available in Node.
+ *
+ * @public
+ * @param ref - StorageReference where data should be downloaded.
+ * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
+ * retrieve.
+ * @returns A stream with the object's data as bytes
+ */
+export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;