@firebase/storage 0.8.7 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 #Unreleased
 
+## 0.9.0
+
+### Minor Changes
+
+- [`e34e98e73`](https://github.com/firebase/firebase-js-sdk/commit/e34e98e73a72f77ee87d9005d6728402129deda9) [#5672](https://github.com/firebase/firebase-js-sdk/pull/5672) (fixes [#76](https://github.com/firebase/firebase-js-sdk/issues/76)) - Adds `getBytes()`, `getStream()` and `getBlob()`, which allow direct file downloads from the SDK.
+
+### Patch Changes
+
+- [`0394cc97b`](https://github.com/firebase/firebase-js-sdk/commit/0394cc97b98f04dae87b718655eb46174275ebc2) [#5743](https://github.com/firebase/firebase-js-sdk/pull/5743) - Fix typings for storage and storage-compat.
+
 ## 0.8.7
 
 ### Patch Changes

package/dist/index.browser.cjs.js

@@ -587,6 +587,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_`.
+ */
 var NetworkRequest = /** @class */ (function () {
     function NetworkRequest(url_, method_, headers_, body_, successCodes_, additionalRetryCodes_, callback_, errorCallback_, timeout_, progressCallback_, connectionFactory_) {
         var _this = this;
@@ -665,7 +673,7 @@ var NetworkRequest = /** @class */ (function () {
             var connection = status.connection;
             if (status.wasSuccessCode) {
                 try {
-                    var result = _this.callback_(connection, connection.getResponseText());
+                    var result = _this.callback_(connection, connection.getResponse());
                     if (isJustDef(result)) {
                         resolve(result);
                     }
@@ -680,7 +688,7 @@ var NetworkRequest = /** @class */ (function () {
             else {
                 if (connection !== null) {
                     var err = unknown();
-                    err.serverResponse = connection.getResponseText();
+                    err.serverResponse = connection.getErrorText();
                     if (_this.errorCallback_) {
                         reject(_this.errorCallback_(connection, err));
                     }
@@ -813,7 +821,7 @@ function getBlobBuilder() {
  * @param args The values that will make up the resulting blob.
  * @return The blob.
  */
-function getBlob() {
+function getBlob$1() {
     var args = [];
     for (var _i = 0; _i < arguments.length; _i++) {
         args[_i] = arguments[_i];
@@ -1173,7 +1181,7 @@ var FbsBlob = /** @class */ (function () {
                     return val;
                 }
             });
-            return new FbsBlob(getBlob.apply(null, blobby));
+            return new FbsBlob(getBlob$1.apply(null, blobby));
         }
         else {
             var uint8Arrays = args.map(function (val) {
@@ -1499,6 +1507,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.
+ */
 var RequestInfo = /** @class */ (function () {
     function RequestInfo(url, method, 
     /**
@@ -1583,7 +1597,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 {
@@ -1655,6 +1669,19 @@ function list$2(service, location, delimiter, pageToken, maxResults) {
     requestInfo.errorHandler = sharedErrorHandler(location);
     return requestInfo;
 }
+function getBytes$1(service, location, maxDownloadSizeBytes) {
+    var urlPart = location.fullServerUrl();
+    var url = makeUrl(urlPart, service.host, service._protocol) + '?alt=media';
+    var method = 'GET';
+    var timeout = service.maxOperationRetryTime;
+    var requestInfo = new RequestInfo(url, method, function (_, data) { return 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) {
     var urlPart = location.fullServerUrl();
     var url = makeUrl(urlPart, service.host, service._protocol);
@@ -2067,7 +2094,7 @@ function async(f) {
  * limitations under the License.
  */
 /** An override for the text-based Connection. Used in tests. */
-var connectionFactoryOverride = null;
+var textFactoryOverride = null;
 /**
  * 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.
@@ -2077,6 +2104,7 @@ var XhrConnection = /** @class */ (function () {
         var _this = this;
         this.sent_ = false;
         this.xhr_ = new XMLHttpRequest();
+        this.initXhr();
         this.errorCode_ = ErrorCode.NO_ERROR;
         this.sendPromise_ = new Promise(function (resolve) {
             _this.xhr_.addEventListener('abort', function () {
@@ -2130,11 +2158,17 @@ var XhrConnection = /** @class */ (function () {
             return -1;
         }
     };
-    XhrConnection.prototype.getResponseText = function () {
+    XhrConnection.prototype.getResponse = function () {
         if (!this.sent_) {
-            throw internalError('cannot .getResponseText() before sending');
+            throw internalError('cannot .getResponse() before sending');
         }
-        return this.xhr_.responseText;
+        return this.xhr_.response;
+    };
+    XhrConnection.prototype.getErrorText = function () {
+        if (!this.sent_) {
+            throw internalError('cannot .getErrorText() before sending');
+        }
+        return this.xhr_.statusText;
     };
     /** Aborts the request. */
     XhrConnection.prototype.abort = function () {
@@ -2155,10 +2189,44 @@ var XhrConnection = /** @class */ (function () {
     };
     return XhrConnection;
 }());
-function newConnection() {
-    return connectionFactoryOverride
-        ? connectionFactoryOverride()
-        : new XhrConnection();
+var XhrTextConnection = /** @class */ (function (_super) {
+    tslib.__extends(XhrTextConnection, _super);
+    function XhrTextConnection() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    XhrTextConnection.prototype.initXhr = function () {
+        this.xhr_.responseType = 'text';
+    };
+    return XhrTextConnection;
+}(XhrConnection));
+function newTextConnection() {
+    return textFactoryOverride ? textFactoryOverride() : new XhrTextConnection();
+}
+var XhrBytesConnection = /** @class */ (function (_super) {
+    tslib.__extends(XhrBytesConnection, _super);
+    function XhrBytesConnection() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    XhrBytesConnection.prototype.initXhr = function () {
+        this.xhr_.responseType = 'arraybuffer';
+    };
+    return XhrBytesConnection;
+}(XhrConnection));
+function newBytesConnection() {
+    return new XhrBytesConnection();
+}
+var XhrBlobConnection = /** @class */ (function (_super) {
+    tslib.__extends(XhrBlobConnection, _super);
+    function XhrBlobConnection() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    XhrBlobConnection.prototype.initXhr = function () {
+        this.xhr_.responseType = 'blob';
+    };
+    return XhrBlobConnection;
+}(XhrConnection));
+function newBlobConnection() {
+    return new XhrBlobConnection();
 }
 
 /**
@@ -2306,7 +2374,7 @@ var UploadTask = /** @class */ (function () {
         var _this = this;
         this._resolveToken(function (authToken, appCheckToken) {
             var requestInfo = createResumableUpload(_this._ref.storage, _this._ref._location, _this._mappings, _this._blob, _this._metadata);
-            var createRequest = _this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            var createRequest = _this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             _this._request = createRequest;
             createRequest.getPromise().then(function (url) {
                 _this._request = undefined;
@@ -2322,7 +2390,7 @@ var UploadTask = /** @class */ (function () {
         var url = this._uploadUrl;
         this._resolveToken(function (authToken, appCheckToken) {
             var requestInfo = getResumableUploadStatus(_this._ref.storage, _this._ref._location, url, _this._blob);
-            var statusRequest = _this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            var statusRequest = _this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             _this._request = statusRequest;
             statusRequest.getPromise().then(function (status) {
                 status = status;
@@ -2352,7 +2420,7 @@ var UploadTask = /** @class */ (function () {
                 _this._transition("error" /* ERROR */);
                 return;
             }
-            var uploadRequest = _this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            var uploadRequest = _this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             _this._request = uploadRequest;
             uploadRequest.getPromise().then(function (newStatus) {
                 _this._increaseMultiplier();
@@ -2379,7 +2447,7 @@ var UploadTask = /** @class */ (function () {
         var _this = this;
         this._resolveToken(function (authToken, appCheckToken) {
             var requestInfo = getMetadata$2(_this._ref.storage, _this._ref._location, _this._mappings);
-            var metadataRequest = _this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            var metadataRequest = _this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             _this._request = metadataRequest;
             metadataRequest.getPromise().then(function (metadata) {
                 _this._request = undefined;
@@ -2392,7 +2460,7 @@ var UploadTask = /** @class */ (function () {
         var _this = this;
         this._resolveToken(function (authToken, appCheckToken) {
             var requestInfo = multipartUpload(_this._ref.storage, _this._ref._location, _this._mappings, _this._blob, _this._metadata);
-            var multipartRequest = _this._ref.storage._makeRequest(requestInfo, newConnection, authToken, appCheckToken);
+            var multipartRequest = _this._ref.storage._makeRequest(requestInfo, newTextConnection, authToken, appCheckToken);
             _this._request = multipartRequest;
             multipartRequest.getPromise().then(function (metadata) {
                 _this._request = undefined;
@@ -2789,6 +2857,38 @@ var Reference = /** @class */ (function () {
     };
     return Reference;
 }());
+/**
+ * Download the bytes at the object's location.
+ * @returns A Promise containing the downloaded bytes.
+ */
+function getBytesInternal(ref, maxDownloadSizeBytes) {
+    ref._throwIfRoot('getBytes');
+    var requestInfo = getBytes$1(ref.storage, ref._location, maxDownloadSizeBytes);
+    return ref.storage
+        .makeRequestWithTokens(requestInfo, newBytesConnection)
+        .then(function (bytes) {
+        return maxDownloadSizeBytes !== undefined
+            ? // GCS may not honor the Range header for small files
+                bytes.slice(0, maxDownloadSizeBytes)
+            : bytes;
+    });
+}
+/**
+ * Download the bytes at the object's location.
+ * @returns A Promise containing the downloaded blob.
+ */
+function getBlobInternal(ref, maxDownloadSizeBytes) {
+    ref._throwIfRoot('getBlob');
+    var requestInfo = getBytes$1(ref.storage, ref._location, maxDownloadSizeBytes);
+    return ref.storage
+        .makeRequestWithTokens(requestInfo, newBlobConnection)
+        .then(function (blob) {
+        return maxDownloadSizeBytes !== undefined
+            ? // GCS may not honor the Range header for small files
+                blob.slice(0, maxDownloadSizeBytes)
+            : blob;
+    });
+}
 /**
  * Uploads data to this object's location.
  * The upload is not resumable.
@@ -2802,7 +2902,7 @@ function uploadBytes$1(ref, data, metadata) {
     ref._throwIfRoot('uploadBytes');
     var requestInfo = multipartUpload(ref.storage, ref._location, getMappings(), new FbsBlob(data, true), metadata);
     return ref.storage
-        .makeRequestWithTokens(requestInfo, newConnection)
+        .makeRequestWithTokens(requestInfo, newTextConnection)
         .then(function (finalMetadata) {
         return {
             metadata: finalMetadata,
@@ -2934,7 +3034,7 @@ function list$1(ref, options) {
     var op = options || {};
     var 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
@@ -2946,7 +3046,7 @@ function list$1(ref, options) {
 function getMetadata$1(ref) {
     ref._throwIfRoot('getMetadata');
     var 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.
@@ -2962,7 +3062,7 @@ function getMetadata$1(ref) {
 function updateMetadata$1(ref, metadata) {
     ref._throwIfRoot('updateMetadata');
     var 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.
@@ -2974,7 +3074,7 @@ function getDownloadURL$1(ref) {
     ref._throwIfRoot('getDownloadURL');
     var requestInfo = getDownloadUrl(ref.storage, ref._location, getMappings());
     return ref.storage
-        .makeRequestWithTokens(requestInfo, newConnection)
+        .makeRequestWithTokens(requestInfo, newTextConnection)
         .then(function (url) {
         if (url === null) {
             throw noDownloadURL();
@@ -2991,7 +3091,7 @@ function getDownloadURL$1(ref) {
 function deleteObject$1(ref) {
     ref._throwIfRoot('deleteObject');
     var 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`.
@@ -3291,7 +3391,7 @@ var FirebaseStorageImpl = /** @class */ (function () {
 }());
 
 var name = "@firebase/storage";
-var version = "0.8.7";
+var version = "0.9.0";
 
 /**
  * @license
@@ -3330,6 +3430,24 @@ var 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.
@@ -3506,6 +3624,58 @@ 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
+ */
+function getBlob(ref, maxDownloadSizeBytes) {
+    ref = util.getModularInstance(ref);
+    return getBlobInternal(ref, maxDownloadSizeBytes);
+}
+/**
+ * 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) {
+    throw new Error('getStream() is only supported by NodeJS builds');
+}
+
 /**
  * Cloud Storage for Firebase
  *
@@ -3539,9 +3709,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;