@firebase/storage 0.8.7 → 0.9.0

package/dist/node-esm/src/api.browser.d.ts

@@ -14,4 +14,35 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};
+/// <reference types="node" />
+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): NodeJS.ReadableStream;

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

@@ -33,6 +33,21 @@ 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.

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

@@ -14,4 +14,35 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};
+/// <reference types="node" />
+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): NodeJS.ReadableStream;

package/dist/node-esm/src/implementation/connection.d.ts

@@ -14,21 +14,31 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/// <reference types="node" />
 /** Network headers */
 export declare type Headers = Record<string, string>;
+/** Response type exposed by the networking APIs. */
+export declare type ConnectionType = string | ArrayBuffer | Blob | NodeJS.ReadableStream;
 /**
  * A lightweight wrapper around XMLHttpRequest with a
  * goog.net.XhrIo-like interface.
+ *
+ * You can create a new connection by invoking `newTextConnection()`,
+ * `newBytesConnection()` or `newStreamConnection()`.
  */
-export interface Connection {
+export interface Connection<T extends ConnectionType> {
     /**
-     * This method should never reject. In case of encountering an error, set an error code internally which can be accessed
-     * by calling getErrorCode() by callers.
+     * Sends a request to the provided URL.
+     *
+     * This method never rejects its promise. In case of encountering an error,
+     * it sets an error code internally which can be accessed by calling
+     * getErrorCode() by callers.
      */
     send(url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers): Promise<void>;
     getErrorCode(): ErrorCode;
     getStatus(): number;
-    getResponseText(): string;
+    getResponse(): T;
+    getErrorText(): string;
     /**
      * Abort the request.
      */

package/dist/node-esm/src/implementation/request.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { RequestInfo } from './requestinfo';
-import { Headers, Connection } from './connection';
+import { Connection, Headers, ConnectionType } from './connection';
 export interface Request<T> {
     getPromise(): Promise<T>;
     /**
@@ -31,17 +31,17 @@ export interface Request<T> {
  * A collection of information about the result of a network request.
  * @param opt_canceled - Defaults to false.
  */
-export declare class RequestEndStatus {
+export declare class RequestEndStatus<I extends ConnectionType> {
     wasSuccessCode: boolean;
-    connection: Connection | null;
+    connection: Connection<I> | null;
     /**
      * True if the request was canceled.
      */
     canceled: boolean;
-    constructor(wasSuccessCode: boolean, connection: Connection | null, canceled?: boolean);
+    constructor(wasSuccessCode: boolean, connection: Connection<I> | null, canceled?: boolean);
 }
 export declare function addAuthHeader_(headers: Headers, authToken: string | null): void;
 export declare function addVersionHeader_(headers: Headers, firebaseVersion?: string): void;
 export declare function addGmpidHeader_(headers: Headers, appId: string | null): void;
 export declare function addAppCheckHeader_(headers: Headers, appCheckToken: string | null): void;
-export declare function makeRequest<T>(requestInfo: RequestInfo<T>, appId: string | null, authToken: string | null, appCheckToken: string | null, requestFactory: () => Connection, firebaseVersion?: string): Request<T>;
+export declare function makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, appId: string | null, authToken: string | null, appCheckToken: string | null, requestFactory: () => Connection<I>, firebaseVersion?: string): Request<O>;

package/dist/node-esm/src/implementation/requestinfo.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { StorageError } from './error';
-import { Headers, Connection } from './connection';
+import { Headers, Connection, ConnectionType } from './connection';
 /**
  * Type for url params stored in RequestInfo.
  */
@@ -29,8 +29,16 @@ export interface UrlParams {
  * @param I - the type of the backend's network response
  * @param O - the output response type used by the rest of the SDK.
  */
-export declare type RequestHandler<I, O> = (connection: Connection, response: I) => O;
-export declare class RequestInfo<T> {
+export declare type RequestHandler<I extends ConnectionType, O> = (connection: Connection<I>, response: I) => O;
+/** A function to handle an error. */
+export declare type ErrorHandler = (connection: Connection<ConnectionType>, response: StorageError) => StorageError;
+/**
+ * Contains a fully specified request.
+ *
+ * @param I - the type of the backend's network response.
+ * @param O - the output response type used by the rest of the SDK.
+ */
+export declare class RequestInfo<I extends ConnectionType, O> {
     url: string;
     method: string;
     /**
@@ -40,12 +48,12 @@ export declare class RequestInfo<T> {
      * Note: The XhrIo passed to this function may be reused after this callback
      * returns. Do not keep a reference to it in any way.
      */
-    handler: RequestHandler<string, T>;
+    handler: RequestHandler<I, O>;
     timeout: number;
     urlParams: UrlParams;
     headers: Headers;
     body: Blob | string | Uint8Array | null;
-    errorHandler: RequestHandler<StorageError, StorageError> | null;
+    errorHandler: ErrorHandler | null;
     /**
      * Called with the current number of bytes uploaded and total size (-1 if not
      * computable) of the request body (i.e. used to report upload progress).
@@ -61,5 +69,5 @@ export declare class RequestInfo<T> {
      * Note: The XhrIo passed to this function may be reused after this callback
      * returns. Do not keep a reference to it in any way.
      */
-    handler: RequestHandler<string, T>, timeout: number);
+    handler: RequestHandler<I, O>, timeout: number);
 }

package/dist/node-esm/src/implementation/requests.d.ts

@@ -24,28 +24,29 @@ import { StorageError } from './error';
 import { Location } from './location';
 import { Mappings } from './metadata';
 import { RequestInfo } from './requestinfo';
-import { Connection } from './connection';
+import { Connection, ConnectionType } from './connection';
 import { FirebaseStorageImpl } from '../service';
 /**
  * Throws the UNKNOWN StorageError if cndn is false.
  */
 export declare function handlerCheck(cndn: boolean): void;
-export declare function metadataHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection, p2: string) => Metadata;
-export declare function listHandler(service: FirebaseStorageImpl, bucket: string): (p1: Connection, p2: string) => ListResult;
-export declare function downloadUrlHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection, p2: string) => string | null;
-export declare function sharedErrorHandler(location: Location): (p1: Connection, p2: StorageError) => StorageError;
-export declare function objectErrorHandler(location: Location): (p1: Connection, p2: StorageError) => StorageError;
-export declare function getMetadata(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<Metadata>;
-export declare function list(service: FirebaseStorageImpl, location: Location, delimiter?: string, pageToken?: string | null, maxResults?: number | null): RequestInfo<ListResult>;
-export declare function getDownloadUrl(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<string | null>;
-export declare function updateMetadata(service: FirebaseStorageImpl, location: Location, metadata: Partial<Metadata>, mappings: Mappings): RequestInfo<Metadata>;
-export declare function deleteObject(service: FirebaseStorageImpl, location: Location): RequestInfo<void>;
+export declare function metadataHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection<string>, p2: string) => Metadata;
+export declare function listHandler(service: FirebaseStorageImpl, bucket: string): (p1: Connection<string>, p2: string) => ListResult;
+export declare function downloadUrlHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection<string>, p2: string) => string | null;
+export declare function sharedErrorHandler(location: Location): (p1: Connection<ConnectionType>, p2: StorageError) => StorageError;
+export declare function objectErrorHandler(location: Location): (p1: Connection<ConnectionType>, p2: StorageError) => StorageError;
+export declare function getMetadata(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<string, Metadata>;
+export declare function list(service: FirebaseStorageImpl, location: Location, delimiter?: string, pageToken?: string | null, maxResults?: number | null): RequestInfo<string, ListResult>;
+export declare function getBytes<I extends ConnectionType>(service: FirebaseStorageImpl, location: Location, maxDownloadSizeBytes?: number): RequestInfo<I, I>;
+export declare function getDownloadUrl(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<string, string | null>;
+export declare function updateMetadata(service: FirebaseStorageImpl, location: Location, metadata: Partial<Metadata>, mappings: Mappings): RequestInfo<string, Metadata>;
+export declare function deleteObject(service: FirebaseStorageImpl, location: Location): RequestInfo<string, void>;
 export declare function determineContentType_(metadata: Metadata | null, blob: FbsBlob | null): string;
 export declare function metadataForUpload_(location: Location, blob: FbsBlob, metadata?: Metadata | null): Metadata;
 /**
  * Prepare RequestInfo for uploads as Content-Type: multipart.
  */
-export declare function multipartUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<Metadata>;
+export declare function multipartUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<string, Metadata>;
 /**
  * @param current The number of bytes that have been uploaded so far.
  * @param total The total number of bytes in the upload.
@@ -60,12 +61,12 @@ export declare class ResumableUploadStatus {
     metadata: Metadata | null;
     constructor(current: number, total: number, finalized?: boolean, metadata?: Metadata | null);
 }
-export declare function checkResumeHeader_(xhr: Connection, allowed?: string[]): string;
-export declare function createResumableUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<string>;
+export declare function checkResumeHeader_(xhr: Connection<string>, allowed?: string[]): string;
+export declare function createResumableUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<string, string>;
 /**
  * @param url From a call to fbs.requests.createResumableUpload.
  */
-export declare function getResumableUploadStatus(service: FirebaseStorageImpl, location: Location, url: string, blob: FbsBlob): RequestInfo<ResumableUploadStatus>;
+export declare function getResumableUploadStatus(service: FirebaseStorageImpl, location: Location, url: string, blob: FbsBlob): RequestInfo<string, ResumableUploadStatus>;
 /**
  * Any uploads via the resumable upload API must transfer a number of bytes
  * that is a multiple of this number.
@@ -80,4 +81,4 @@ export declare const RESUMABLE_UPLOAD_CHUNK_SIZE: number;
  *     has a final size inconsistent with the blob, or the blob cannot be sliced
  *     for upload.
  */
-export declare function continueResumableUpload(location: Location, service: FirebaseStorageImpl, url: string, blob: FbsBlob, chunkSize: number, mappings: Mappings, status?: ResumableUploadStatus | null, progressCallback?: ((p1: number, p2: number) => void) | null): RequestInfo<ResumableUploadStatus>;
+export declare function continueResumableUpload(location: Location, service: FirebaseStorageImpl, url: string, blob: FbsBlob, chunkSize: number, mappings: Mappings, status?: ResumableUploadStatus | null, progressCallback?: ((p1: number, p2: number) => void) | null): RequestInfo<string, ResumableUploadStatus>;

package/dist/node-esm/src/platform/browser/connection.d.ts

@@ -14,26 +14,43 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Headers, Connection, ErrorCode } from '../../implementation/connection';
+/// <reference types="node" />
+import { Connection, ConnectionType, ErrorCode, Headers } from '../../implementation/connection';
 /**
  * Network layer for browsers. We use this instead of goog.net.XhrIo because
  * goog.net.XhrIo is hyuuuuge and doesn't work in React Native on Android.
  */
-export declare class XhrConnection implements Connection {
-    private xhr_;
+declare abstract class XhrConnection<T extends ConnectionType> implements Connection<T> {
+    protected xhr_: XMLHttpRequest;
     private errorCode_;
     private sendPromise_;
-    private sent_;
+    protected sent_: boolean;
     constructor();
+    abstract initXhr(): void;
     send(url: string, method: string, body?: ArrayBufferView | Blob | string, headers?: Headers): Promise<void>;
     getErrorCode(): ErrorCode;
     getStatus(): number;
-    getResponseText(): string;
+    getResponse(): T;
+    getErrorText(): string;
     /** Aborts the request. */
     abort(): void;
     getResponseHeader(header: string): string | null;
     addUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
     removeUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
 }
-export declare function newConnection(): Connection;
-export declare function injectTestConnection(factory: (() => Connection) | null): void;
+export declare class XhrTextConnection extends XhrConnection<string> {
+    initXhr(): void;
+}
+export declare function newTextConnection(): Connection<string>;
+export declare class XhrBytesConnection extends XhrConnection<ArrayBuffer> {
+    private data_?;
+    initXhr(): void;
+}
+export declare function newBytesConnection(): Connection<ArrayBuffer>;
+export declare class XhrBlobConnection extends XhrConnection<Blob> {
+    initXhr(): void;
+}
+export declare function newBlobConnection(): Connection<Blob>;
+export declare function newStreamConnection(): Connection<NodeJS.ReadableStream>;
+export declare function injectTestConnection(factory: (() => Connection<string>) | null): void;
+export {};

package/dist/node-esm/src/platform/connection.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -15,5 +16,8 @@
  * limitations under the License.
  */
 import { Connection } from '../implementation/connection';
-export declare function newConnection(): Connection;
-export declare function injectTestConnection(factory: (() => Connection) | null): void;
+export declare function injectTestConnection(factory: (() => Connection<string>) | null): void;
+export declare function newTextConnection(): Connection<string>;
+export declare function newBytesConnection(): Connection<ArrayBuffer>;
+export declare function newBlobConnection(): Connection<Blob>;
+export declare function newStreamConnection(): Connection<NodeJS.ReadableStream>;

package/dist/node-esm/src/platform/node/connection.d.ts

@@ -14,32 +14,48 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ErrorCode, Connection } from '../../implementation/connection';
+/// <reference types="node" />
+import { Connection, ConnectionType, ErrorCode } from '../../implementation/connection';
+import nodeFetch, { Headers } from 'node-fetch';
 /**
  * Network layer that works in Node.
  *
  * This network implementation should not be used in browsers as it does not
  * support progress updates.
  */
-export declare class FetchConnection implements Connection {
-    private errorCode_;
-    private statusCode_;
-    private body_;
-    private headers_;
-    private sent_;
-    private fetch_;
+declare abstract class FetchConnection<T extends ConnectionType> implements Connection<T> {
+    protected errorCode_: ErrorCode;
+    protected statusCode_: number | undefined;
+    protected body_: ArrayBuffer | undefined;
+    protected errorText_: string;
+    protected headers_: Headers | undefined;
+    protected sent_: boolean;
+    protected fetch_: typeof nodeFetch;
     constructor();
     send(url: string, method: string, body?: ArrayBufferView | Blob | string, headers?: Record<string, string>): Promise<void>;
     getErrorCode(): ErrorCode;
     getStatus(): number;
-    getResponseText(): string;
+    abstract getResponse(): T;
+    getErrorText(): string;
     abort(): void;
     getResponseHeader(header: string): string | null;
     addUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
-    /**
-     * @override
-     */
     removeUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
 }
-export declare function newConnection(): Connection;
-export declare function injectTestConnection(factory: (() => Connection) | null): void;
+export declare class FetchTextConnection extends FetchConnection<string> {
+    getResponse(): string;
+}
+export declare function newTextConnection(): Connection<string>;
+export declare class FetchBytesConnection extends FetchConnection<ArrayBuffer> {
+    getResponse(): ArrayBuffer;
+}
+export declare function newBytesConnection(): Connection<ArrayBuffer>;
+export declare class FetchStreamConnection extends FetchConnection<NodeJS.ReadableStream> {
+    private stream_;
+    send(url: string, method: string, body?: ArrayBufferView | Blob | string, headers?: Record<string, string>): Promise<void>;
+    getResponse(): NodeJS.ReadableStream;
+}
+export declare function newStreamConnection(): Connection<NodeJS.ReadableStream>;
+export declare function newBlobConnection(): Connection<Blob>;
+export declare function injectTestConnection(factory: (() => Connection<string>) | null): void;
+export {};

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

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/// <reference types="node" />
 import { Location } from './implementation/location';
 import { ListOptions, UploadResult } from './public-types';
 import { StringFormat } from './implementation/string';
@@ -75,6 +76,18 @@ export declare class Reference {
      */
     _throwIfRoot(name: string): void;
 }
+/**
+ * Download the bytes at the object's location.
+ * @returns A Promise containing the downloaded bytes.
+ */
+export declare function getBytesInternal(ref: Reference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
+/**
+ * Download the bytes at the object's location.
+ * @returns A Promise containing the downloaded blob.
+ */
+export declare function getBlobInternal(ref: Reference, maxDownloadSizeBytes?: number): Promise<Blob>;
+/** Stream the bytes at the object's location. */
+export declare function getStreamInternal(ref: Reference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
 /**
  * Uploads data to this object's location.
  * The upload is not resumable.

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

@@ -24,7 +24,7 @@ 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 } from './implementation/connection';
+import { Connection, ConnectionType } from './implementation/connection';
 export declare function isUrl(path?: string): boolean;
 /**
  * Returns a storage Reference for the given url.
@@ -125,6 +125,6 @@ export declare class FirebaseStorageImpl implements FirebaseStorage {
      * @param requestInfo - HTTP RequestInfo object
      * @param authToken - Firebase auth token
      */
-    _makeRequest<T>(requestInfo: RequestInfo<T>, requestFactory: () => Connection, authToken: string | null, appCheckToken: string | null): Request<T>;
-    makeRequestWithTokens<T>(requestInfo: RequestInfo<T>, requestFactory: () => Connection): Promise<T>;
+    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null): Request<O>;
+    makeRequestWithTokens<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>): Promise<O>;
 }

package/dist/node-esm/test/integration/integration.test.d.ts

@@ -14,7 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { FirebaseApp } from '@firebase/app';
+import * as types from '../../src/public-types';
 export declare const PROJECT_ID: any;
 export declare const STORAGE_BUCKET: any;
 export declare const API_KEY: any;
 export declare const AUTH_DOMAIN: any;
+export declare function createApp(): Promise<FirebaseApp>;
+export declare function createStorage(app: FirebaseApp): types.FirebaseStorage;

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

@@ -21,7 +21,7 @@ export declare enum State {
     SENT = 1,
     DONE = 2
 }
-export declare class TestingConnection implements Connection {
+export declare class TestingConnection implements Connection<string> {
     private state;
     private sendPromise;
     private resolve;
@@ -37,10 +37,11 @@ export declare class TestingConnection implements Connection {
     }): void;
     getErrorCode(): ErrorCode;
     getStatus(): number;
-    getResponseText(): string;
+    getResponse(): string;
+    getErrorText(): string;
     abort(): void;
     getResponseHeader(header: string): string | null;
     addUploadProgressListener(): void;
     removeUploadProgressListener(): void;
 }
-export declare function newTestConnection(sendHook?: SendHook | null): Connection;
+export declare function newTestConnection(sendHook?: SendHook | null): Connection<string>;

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

@@ -1,6 +1,6 @@
 import { FirebaseApp } from '@firebase/app-types';
 import { StorageError } from '../../src/implementation/error';
-import { Headers, Connection } from '../../src/implementation/connection';
+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';
@@ -24,7 +24,7 @@ export declare function makeFakeAppCheckProvider(tokenResult: {
  * Returns something that looks like an fbs.XhrIo with the given headers
  * and status.
  */
-export declare function fakeXhrIo(headers: Headers, status?: number): Connection;
+export declare function fakeXhrIo<I extends ConnectionType = string>(headers: Headers, status?: number): Connection<I>;
 /**
  * Binds ignoring types. Used to test calls involving improper arguments.
  */

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

@@ -14,4 +14,35 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};
+/// <reference types="node" />
+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): NodeJS.ReadableStream;

package/dist/src/api.d.ts

@@ -33,6 +33,21 @@ 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.

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

@@ -14,4 +14,35 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};
+/// <reference types="node" />
+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): NodeJS.ReadableStream;