@firebase/storage 0.8.6 → 0.8.7-canary.ce39a1a07

package/dist/index.node.cjs.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var app = require('@firebase/app');
 var util = require('@firebase/util');
+var stream = require('stream');
 var nodeFetch = require('node-fetch');
 var component = require('@firebase/component');
 
@@ -345,7 +346,9 @@ callback, timeout) {
     // Would type this as "number" but that doesn't work for Node so ¯\_(ツ)_/¯
     // TODO: find a way to exclude Node type definition for storage because storage only works in browser
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    let timeoutId = null;
+    let retryTimeoutId = null;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let globalTimeoutId = null;
     let hitTimeout = false;
     let cancelState = 0;
     function canceled() {
@@ -359,21 +362,29 @@ callback, timeout) {
         }
     }
     function callWithDelay(millis) {
-        timeoutId = setTimeout(() => {
-            timeoutId = null;
+        retryTimeoutId = setTimeout(() => {
+            retryTimeoutId = null;
             f(handler, canceled());
         }, millis);
     }
+    function clearGlobalTimeout() {
+        if (globalTimeoutId) {
+            clearTimeout(globalTimeoutId);
+        }
+    }
     function handler(success, ...args) {
         if (triggeredCallback) {
+            clearGlobalTimeout();
             return;
         }
         if (success) {
+            clearGlobalTimeout();
             triggerCallback.call(null, success, ...args);
             return;
         }
         const mustStop = canceled() || hitTimeout;
         if (mustStop) {
+            clearGlobalTimeout();
             triggerCallback.call(null, success, ...args);
             return;
         }
@@ -397,14 +408,15 @@ callback, timeout) {
             return;
         }
         stopped = true;
+        clearGlobalTimeout();
         if (triggeredCallback) {
             return;
         }
-        if (timeoutId !== null) {
+        if (retryTimeoutId !== null) {
             if (!wasTimeout) {
                 cancelState = 2;
             }
-            clearTimeout(timeoutId);
+            clearTimeout(retryTimeoutId);
             callWithDelay(0);
         }
         else {
@@ -414,7 +426,7 @@ callback, timeout) {
         }
     }
     callWithDelay(0);
-    setTimeout(() => {
+    globalTimeoutId = setTimeout(() => {
         hitTimeout = true;
         stop(true);
     }, timeout);
@@ -554,6 +566,14 @@ var ErrorCode;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Handles network logic for all Storage Requests, including error reporting and
+ * retries with backoff.
+ *
+ * @param I - the type of the backend's network response.
+ * @param - O the output type used by the rest of the SDK. The conversion
+ * happens in the specified `callback_`.
+ */
 class NetworkRequest {
     constructor(url_, method_, headers_, body_, successCodes_, additionalRetryCodes_, callback_, errorCallback_, timeout_, progressCallback_, connectionFactory_) {
         this.url_ = url_;
@@ -630,7 +650,7 @@ class NetworkRequest {
             const connection = status.connection;
             if (status.wasSuccessCode) {
                 try {
-                    const result = this.callback_(connection, connection.getResponseText());
+                    const result = this.callback_(connection, connection.getResponse());
                     if (isJustDef(result)) {
                         resolve(result);
                     }
@@ -645,7 +665,7 @@ class NetworkRequest {
             else {
                 if (connection !== null) {
                     const err = unknown();
-                    err.serverResponse = connection.getResponseText();
+                    err.serverResponse = connection.getErrorText();
                     if (this.errorCallback_) {
                         reject(this.errorCallback_(connection, err));
                     }
@@ -776,7 +796,7 @@ function getBlobBuilder() {
  * @param args The values that will make up the resulting blob.
  * @return The blob.
  */
-function getBlob(...args) {
+function getBlob$1(...args) {
     const BlobBuilder = getBlobBuilder();
     if (BlobBuilder !== undefined) {
         const bb = new BlobBuilder();
@@ -1131,7 +1151,7 @@ class FbsBlob {
                     return val;
                 }
             });
-            return new FbsBlob(getBlob.apply(null, blobby));
+            return new FbsBlob(getBlob$1.apply(null, blobby));
         }
         else {
             const uint8Arrays = args.map((val) => {
@@ -1453,6 +1473,12 @@ function fromResponseString(service, bucket, resourceString) {
     return fromBackendResponse(service, bucket, resource);
 }
 
+/**
+ * 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.
+ */
 class RequestInfo {
     constructor(url, method, 
     /**
@@ -1536,7 +1562,7 @@ function sharedErrorHandler(location) {
             if (
             // This exact message string is the only consistent part of the
             // server's error response that identifies it as an App Check error.
-            xhr.getResponseText().includes('Firebase App Check token is invalid')) {
+            xhr.getErrorText().includes('Firebase App Check token is invalid')) {
                 newErr = unauthorizedApp();
             }
             else {
@@ -1608,6 +1634,19 @@ function list$2(service, location, delimiter, pageToken, maxResults) {
     requestInfo.errorHandler = sharedErrorHandler(location);
     return requestInfo;
 }
+function getBytes$1(service, location, maxDownloadSizeBytes) {
+    const urlPart = location.fullServerUrl();
+    const url = makeUrl(urlPart, service.host, service._protocol) + '?alt=media';
+    const method = 'GET';
+    const timeout = service.maxOperationRetryTime;
+    const requestInfo = new RequestInfo(url, method, (_, data) => data, timeout);
+    requestInfo.errorHandler = objectErrorHandler(location);
+    if (maxDownloadSizeBytes !== undefined) {
+        requestInfo.headers['Range'] = `bytes=0-${maxDownloadSizeBytes}`;
+        requestInfo.successCodes = [200 /* OK */, 206 /* Partial Content */];
+    }
+    return requestInfo;
+}
 function getDownloadUrl(service, location, mappings) {
     const urlPart = location.fullServerUrl();
     const url = makeUrl(urlPart, service.host, service._protocol);
@@ -2014,7 +2053,7 @@ function async(f) {
  * limitations under the License.
  */
 /** An override for the text-based Connection. Used in tests. */
-let connectionFactoryOverride = null;
+let textFactoryOverride = null;
 /**
  * Network layer that works in Node.
  *
@@ -2023,31 +2062,33 @@ let connectionFactoryOverride = null;
  */
 class FetchConnection {
     constructor() {
+        this.errorText_ = '';
         this.sent_ = false;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         this.fetch_ = nodeFetch__default["default"];
         this.errorCode_ = ErrorCode.NO_ERROR;
     }
-    send(url, method, body, headers) {
+    async send(url, method, body, headers) {
         if (this.sent_) {
             throw internalError('cannot .send() more than once');
         }
         this.sent_ = true;
-        return this.fetch_(url, {
-            method,
-            headers: headers || {},
-            body
-        }).then(resp => {
-            this.headers_ = resp.headers;
-            this.statusCode_ = resp.status;
-            return resp.text().then(body => {
-                this.body_ = body;
+        try {
+            const response = await this.fetch_(url, {
+                method,
+                headers: headers || {},
+                body: body
             });
-        }, (_err) => {
-            this.errorCode_ = ErrorCode.NETWORK_ERROR;
+            this.headers_ = response.headers;
+            this.statusCode_ = response.status;
+            this.errorCode_ = ErrorCode.NO_ERROR;
+            this.body_ = await response.arrayBuffer();
+        }
+        catch (e) {
+            this.errorText_ = e.message;
             // emulate XHR which sets status to 0 when encountering a network error
             this.statusCode_ = 0;
-        });
+            this.errorCode_ = ErrorCode.NETWORK_ERROR;
+        }
     }
     getErrorCode() {
         if (this.errorCode_ === undefined) {
@@ -2061,35 +2102,86 @@ class FetchConnection {
         }
         return this.statusCode_;
     }
-    getResponseText() {
-        if (this.body_ === undefined) {
-            throw internalError('cannot .getResponseText() before receiving response');
-        }
-        return this.body_;
+    getErrorText() {
+        return this.errorText_;
     }
     abort() {
         // Not supported
     }
     getResponseHeader(header) {
         if (!this.headers_) {
-            throw internalError('cannot .getResponseText() before receiving response');
+            throw internalError('cannot .getResponseHeader() before receiving response');
         }
         return this.headers_.get(header);
     }
     addUploadProgressListener(listener) {
         // Not supported
     }
-    /**
-     * @override
-     */
     removeUploadProgressListener(listener) {
         // Not supported
     }
 }
-function newConnection() {
-    return connectionFactoryOverride
-        ? connectionFactoryOverride()
-        : new FetchConnection();
+class FetchTextConnection extends FetchConnection {
+    getResponse() {
+        if (!this.body_) {
+            throw internalError('cannot .getResponse() before receiving response');
+        }
+        return Buffer.from(this.body_).toString('utf-8');
+    }
+}
+function newTextConnection() {
+    return textFactoryOverride
+        ? textFactoryOverride()
+        : new FetchTextConnection();
+}
+class FetchBytesConnection extends FetchConnection {
+    getResponse() {
+        if (!this.body_) {
+            throw internalError('cannot .getResponse() before sending');
+        }
+        return this.body_;
+    }
+}
+function newBytesConnection() {
+    return new FetchBytesConnection();
+}
+class FetchStreamConnection extends FetchConnection {
+    constructor() {
+        super(...arguments);
+        this.stream_ = null;
+    }
+    async send(url, method, body, headers) {
+        if (this.sent_) {
+            throw internalError('cannot .send() more than once');
+        }
+        this.sent_ = true;
+        try {
+            const response = await this.fetch_(url, {
+                method,
+                headers: headers || {},
+                body: body
+            });
+            this.headers_ = response.headers;
+            this.statusCode_ = response.status;
+            this.errorCode_ = ErrorCode.NO_ERROR;
+            this.stream_ = response.body;
+        }
+        catch (e) {
+            this.errorText_ = e.message;
+            // emulate XHR which sets status to 0 when encountering a network error
+            this.statusCode_ = 0;
+            this.errorCode_ = ErrorCode.NETWORK_ERROR;
+        }
+    }
+    getResponse() {
+        if (!this.stream_) {
+            throw internalError('cannot .getResponse() before sending');
+        }
+        return this.stream_;
+    }
+}
+function newStreamConnection() {
+    return new FetchStreamConnection();
 }
 
 /**
@@ -2231,7 +2323,7 @@ class UploadTask {
     _createResumable() {
         this._resolveToken((authToken, appCheckToken) => {
             const requestInfo = createResumableUpload(this._ref.storage, this._ref._location, this._mappings, this._blob, this._metadata);
-            const createRequest = this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            const createRequest = this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             this._request = createRequest;
             createRequest.getPromise().then((url) => {
                 this._request = undefined;
@@ -2246,7 +2338,7 @@ class UploadTask {
         const url = this._uploadUrl;
         this._resolveToken((authToken, appCheckToken) => {
             const requestInfo = getResumableUploadStatus(this._ref.storage, this._ref._location, url, this._blob);
-            const statusRequest = this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            const statusRequest = this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             this._request = statusRequest;
             statusRequest.getPromise().then(status => {
                 status = status;
@@ -2275,7 +2367,7 @@ class UploadTask {
                 this._transition("error" /* ERROR */);
                 return;
             }
-            const uploadRequest = this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            const uploadRequest = this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             this._request = uploadRequest;
             uploadRequest.getPromise().then((newStatus) => {
                 this._increaseMultiplier();
@@ -2301,7 +2393,7 @@ class UploadTask {
     _fetchMetadata() {
         this._resolveToken((authToken, appCheckToken) => {
             const requestInfo = getMetadata$2(this._ref.storage, this._ref._location, this._mappings);
-            const metadataRequest = this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            const metadataRequest = this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             this._request = metadataRequest;
             metadataRequest.getPromise().then(metadata => {
                 this._request = undefined;
@@ -2313,7 +2405,7 @@ class UploadTask {
     _oneShotUpload() {
         this._resolveToken((authToken, appCheckToken) => {
             const requestInfo = multipartUpload(this._ref.storage, this._ref._location, this._mappings, this._blob, this._metadata);
-            const multipartRequest = this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            const multipartRequest = this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             this._request = multipartRequest;
             multipartRequest.getPromise().then(metadata => {
                 this._request = undefined;
@@ -2678,6 +2770,51 @@ class Reference {
         }
     }
 }
+/**
+ * Download the bytes at the object's location.
+ * @returns A Promise containing the downloaded bytes.
+ */
+function getBytesInternal(ref, maxDownloadSizeBytes) {
+    ref._throwIfRoot('getBytes');
+    const requestInfo = getBytes$1(ref.storage, ref._location, maxDownloadSizeBytes);
+    return ref.storage
+        .makeRequestWithTokens(requestInfo, newBytesConnection)
+        .then(bytes => maxDownloadSizeBytes !== undefined
+        ? // GCS may not honor the Range header for small files
+            bytes.slice(0, maxDownloadSizeBytes)
+        : bytes);
+}
+/** Stream the bytes at the object's location. */
+function getStreamInternal(ref, maxDownloadSizeBytes) {
+    ref._throwIfRoot('getStream');
+    const requestInfo = getBytes$1(ref.storage, ref._location, maxDownloadSizeBytes);
+    /** A transformer that passes through the first n bytes. */
+    const newMaxSizeTransform = n => {
+        let missingBytes = n;
+        return {
+            transform(chunk, encoding, callback) {
+                // GCS may not honor the Range header for small files
+                if (chunk.length < missingBytes) {
+                    this.push(chunk);
+                    missingBytes -= chunk.length;
+                }
+                else {
+                    this.push(chunk.slice(0, missingBytes));
+                    this.emit('end');
+                }
+                callback();
+            }
+        };
+    };
+    const result = maxDownloadSizeBytes !== undefined
+        ? new stream.Transform(newMaxSizeTransform(maxDownloadSizeBytes))
+        : new stream.PassThrough();
+    ref.storage
+        .makeRequestWithTokens(requestInfo, newStreamConnection)
+        .then(stream => stream.pipe(result))
+        .catch(e => result.destroy(e));
+    return result;
+}
 /**
  * Uploads data to this object's location.
  * The upload is not resumable.
@@ -2691,7 +2828,7 @@ function uploadBytes$1(ref, data, metadata) {
     ref._throwIfRoot('uploadBytes');
     const requestInfo = multipartUpload(ref.storage, ref._location, getMappings(), new FbsBlob(data, true), metadata);
     return ref.storage
-        .makeRequestWithTokens(requestInfo, newConnection)
+        .makeRequestWithTokens(requestInfo, newTextConnection)
         .then(finalMetadata => {
         return {
             metadata: finalMetadata,
@@ -2808,7 +2945,7 @@ function list$1(ref, options) {
     const op = options || {};
     const requestInfo = list$2(ref.storage, ref._location, 
     /*delimiter= */ '/', op.pageToken, op.maxResults);
-    return ref.storage.makeRequestWithTokens(requestInfo, newConnection);
+    return ref.storage.makeRequestWithTokens(requestInfo, newTextConnection);
 }
 /**
  * A `Promise` that resolves with the metadata for this object. If this
@@ -2820,7 +2957,7 @@ function list$1(ref, options) {
 function getMetadata$1(ref) {
     ref._throwIfRoot('getMetadata');
     const requestInfo = getMetadata$2(ref.storage, ref._location, getMappings());
-    return ref.storage.makeRequestWithTokens(requestInfo, newConnection);
+    return ref.storage.makeRequestWithTokens(requestInfo, newTextConnection);
 }
 /**
  * Updates the metadata for this object.
@@ -2836,7 +2973,7 @@ function getMetadata$1(ref) {
 function updateMetadata$1(ref, metadata) {
     ref._throwIfRoot('updateMetadata');
     const requestInfo = updateMetadata$2(ref.storage, ref._location, metadata, getMappings());
-    return ref.storage.makeRequestWithTokens(requestInfo, newConnection);
+    return ref.storage.makeRequestWithTokens(requestInfo, newTextConnection);
 }
 /**
  * Returns the download URL for the given Reference.
@@ -2848,7 +2985,7 @@ function getDownloadURL$1(ref) {
     ref._throwIfRoot('getDownloadURL');
     const requestInfo = getDownloadUrl(ref.storage, ref._location, getMappings());
     return ref.storage
-        .makeRequestWithTokens(requestInfo, newConnection)
+        .makeRequestWithTokens(requestInfo, newTextConnection)
         .then(url => {
         if (url === null) {
             throw noDownloadURL();
@@ -2865,7 +3002,7 @@ function getDownloadURL$1(ref) {
 function deleteObject$1(ref) {
     ref._throwIfRoot('deleteObject');
     const requestInfo = deleteObject$2(ref.storage, ref._location);
-    return ref.storage.makeRequestWithTokens(requestInfo, newConnection);
+    return ref.storage.makeRequestWithTokens(requestInfo, newTextConnection);
 }
 /**
  * Returns reference for object obtained by appending `childPath` to `ref`.
@@ -3122,7 +3259,7 @@ class FirebaseStorageImpl {
 }
 
 const name = "@firebase/storage";
-const version = "0.8.6";
+const version = "0.8.7-canary.ce39a1a07";
 
 /**
  * @license
@@ -3161,6 +3298,24 @@ const STORAGE_TYPE = 'storage';
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * 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
+ */
+function getBytes(ref, maxDownloadSizeBytes) {
+    ref = util.getModularInstance(ref);
+    return getBytesInternal(ref, maxDownloadSizeBytes);
+}
 /**
  * Uploads data to this object's location.
  * The upload is not resumable.
@@ -3335,6 +3490,59 @@ function connectStorageEmulator(storage, host, port, options = {}) {
     connectStorageEmulator$1(storage, host, port, options);
 }
 
+/**
+ * @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.
+ */
+/**
+ * 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
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function getBlob(ref, maxDownloadSizeBytes) {
+    throw new Error('getBlob() is only available in Browser-like environments');
+}
+/**
+ * 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
+ */
+function getStream(ref, maxDownloadSizeBytes) {
+    ref = util.getModularInstance(ref);
+    return getStreamInternal(ref, maxDownloadSizeBytes);
+}
+
 /**
  * Cloud Storage for Firebase
  *
@@ -3364,9 +3572,12 @@ exports._invalidArgument = invalidArgument;
 exports._invalidRootOperation = invalidRootOperation;
 exports.connectStorageEmulator = connectStorageEmulator;
 exports.deleteObject = deleteObject;
+exports.getBlob = getBlob;
+exports.getBytes = getBytes;
 exports.getDownloadURL = getDownloadURL;
 exports.getMetadata = getMetadata;
 exports.getStorage = getStorage;
+exports.getStream = getStream;
 exports.list = list;
 exports.listAll = listAll;
 exports.ref = ref;