@react-native-firebase/storage 17.3.1 → 17.4.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.4.0](https://github.com/invertase/react-native-firebase/compare/v17.3.2...v17.4.0) (2023-03-25)
+
+### Features
+
+- **storage:** Firebase JS SDK v9 modular API ([#6958](https://github.com/invertase/react-native-firebase/issues/6958)) ([02df92e](https://github.com/invertase/react-native-firebase/commit/02df92e8d76a60e7cfaa80d65d98f4c905a89937))
+
+### [17.3.2](https://github.com/invertase/react-native-firebase/compare/v17.3.1...v17.3.2) (2023-03-05)
+
+**Note:** Version bump only for package @react-native-firebase/storage
+
 ### [17.3.1](https://github.com/invertase/react-native-firebase/compare/v17.3.0...v17.3.1) (2023-02-23)
 
 **Note:** Version bump only for package @react-native-firebase/storage

package/lib/index.d.ts

@@ -924,6 +924,21 @@ export namespace FirebaseStorageTypes {
     error?: NativeFirebaseError;
   }
 
+  /**
+   * Result returned from a non-resumable upload.
+   */
+  export interface TaskResult {
+    /**
+     * The metadata of the tasks via a {@link storage.FullMetadata} interface.
+     */
+    metadata: FullMetadata;
+
+    /**
+     * The {@link storage.Reference} of the task.
+     */
+    ref: Reference;
+  }
+
   /**
    * The options `list()` accepts.
    */
@@ -961,6 +976,16 @@ export namespace FirebaseStorageTypes {
     prefixes: Reference[];
   }
 
+  /**
+   * Storage Emulator options. Web only.
+   */
+  export interface EmulatorMockTokenOptions {
+    /**
+     * the mock auth token to use for unit testing Security Rules.
+     */
+    mockUserToken?: string;
+  }
+
   /**
    * The Cloud Storage service is available for the default app, a given app or a specific storage bucket.
    *

package/lib/index.js

@@ -26,6 +26,31 @@ import StorageStatics from './StorageStatics';
 import { getGsUrlParts, getHttpUrlParts, handleStorageEvent } from './utils';
 import version from './version';
 
+export {
+  getStorage,
+  connectStorageEmulator,
+  ref,
+  deleteObject,
+  getBlob,
+  getBytes,
+  getDownloadURL,
+  getMetadata,
+  getStream,
+  list,
+  listAll,
+  updateMetadata,
+  putFile,
+  writeToFile,
+  toString,
+  child,
+  setMaxDownloadRetryTime,
+  setMaxOperationRetryTime,
+  setMaxUploadRetryTime,
+  refFromURL,
+  uploadString,
+  uploadBytesResumable,
+} from '../modular/index';
+
 const namespace = 'storage';
 const nativeEvents = ['storage_event'];
 const nativeModuleName = 'RNFBStorageModule';

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '17.3.1';
+module.exports = '17.4.0';

package/modular/index.js

@@ -0,0 +1,268 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library 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 { firebase } from '..';
+
+/**
+ * Returns a Storage instance for the given app.
+ * @param app - FirebaseApp. Optional.
+ * @param bucketUrl - Storage bucket URL. Optional.
+ * @returns {Storage}
+ */
+export function getStorage(app, bucketUrl) {
+  if (app) {
+    if (bucketUrl != null) {
+      return firebase.app(app.name).storage(bucketUrl);
+    }
+
+    return firebase.app(app.name).storage();
+  }
+
+  if (bucketUrl != null) {
+    return firebase.app().storage(bucketUrl);
+  }
+
+  return firebase.app().storage();
+}
+
+/**
+ * Modify this Storage instance to communicate with the Firebase Storage emulator.
+ * @param storage - Storage instance.
+ * @param host - emulator host (e.g. - 'localhost')
+ * @param port - emulator port (e.g. -  9199)
+ * @param options - `EmulatorMockTokenOptions` instance. Optional. Web only.
+ * @returns {void}
+ */
+export function connectStorageEmulator(storage, host, port, options) {
+  return storage.useEmulator(host, port, options);
+}
+
+/**
+ * Modify this Storage instance to communicate with the Firebase Storage emulator.
+ * @param storage - Storage instance.
+ * @param path An optional string pointing to a location on the storage bucket. If no path
+ * is provided, the returned reference will be the bucket root path. Optional.
+ * @returns {Storage.Reference}
+ */
+export function ref(storage, path) {
+  return storage.ref(path);
+}
+
+/**
+ * Deletes the object at this reference's location.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<void>}
+ */
+export function deleteObject(storageRef) {
+  return storageRef.delete();
+}
+
+/**
+ * Downloads the data at the object's location. Returns an error if the object is not found.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<Blob>}
+ */
+// eslint-disable-next-line
+export function getBlob(storageRef) {
+  throw new Error('`getBlob()` is not implemented');
+}
+
+/**
+ * Downloads the data at the object's location. Returns an error if the object is not found.
+ * @param storageRef - Storage `Reference` instance.
+ * @param maxDownloadSizeBytes - The maximum allowed size in bytes to retrieve. Web only.
+ * @returns {Promise<ArrayBuffer>}
+ */
+// eslint-disable-next-line
+export function getBytes(storageRef, maxDownloadSizeBytes) {
+  throw new Error('`getBytes()` is not implemented');
+}
+
+/**
+ * Deletes the object at this reference's location.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<string>}
+ */
+export function getDownloadURL(storageRef) {
+  return storageRef.getDownloadURL();
+}
+
+/**
+ * Fetches metadata for the object at this location, if one exists.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<FullMetadata>}
+ */
+export function getMetadata(storageRef) {
+  return storageRef.getMetadata();
+}
+
+/**
+ * Downloads the data at the object's location. This API is only available in Nodejs.
+ * @param storageRef - Storage `Reference` instance.
+ * @param maxDownloadSizeBytes - The maximum allowed size in bytes to retrieve. Web only.
+ * @returns {NodeJS.ReadableStream;}
+ */
+// eslint-disable-next-line
+export function getStream(storageRef, maxDownloadSizeBytes) {
+  throw new Error('`getStream()` is not implemented');
+}
+
+/**
+ * List items (files) and prefixes (folders) under this storage reference
+ * @param storageRef - Storage `Reference` instance.
+ * @param options - Storage `ListOptions` instance. The options list() accepts.
+ * @returns {Promise<ListResult>}
+ */
+export function list(storageRef, options) {
+  return storageRef.list(options);
+}
+
+/**
+ * List all items (files) and prefixes (folders) under this storage reference.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<ListResult>}
+ */
+export function listAll(storageRef) {
+  return storageRef.listAll();
+}
+
+/**
+ * Updates the metadata for this object.
+ * @param storageRef - Storage `Reference` instance.
+ * @param metadata - A Storage `SettableMetadata` instance to update.
+ * @returns {Promise<FullMetadata>}
+ */
+export function updateMetadata(storageRef, metadata) {
+  return storageRef.updateMetadata(metadata);
+}
+
+/**
+ * Uploads data to this object's location. The upload is not resumable.
+ * @param storageRef - Storage `Reference` instance.
+ * @param data - The data (Blob | Uint8Array | ArrayBuffer) to upload to the storage bucket at the reference location.
+ * @param metadata - A Storage `SettableMetadata` instance to update. Optional.
+ * @returns {Promise<TaskResult>}
+ */
+// eslint-disable-next-line
+export async function uploadBytes(storageRef, data, metadata) {
+  throw new Error('`uploadBytes()` is not implemented');
+}
+
+/**
+ * Uploads data to this object's location. The upload is not resumable.
+ * @param storageRef - Storage `Reference` instance.
+ * @param data - The data (Blob | Uint8Array | ArrayBuffer) to upload to the storage bucket at the reference location.
+ * @param metadata - A Storage `SettableMetadata` instance to update. Optional.
+ * @returns {Task}
+ */
+export function uploadBytesResumable(storageRef, data, metadata) {
+  return storageRef.put(data, metadata);
+}
+
+/**
+ * Uploads data to this object's location. The upload is not resumable.
+ * @param storageRef - Storage `Reference` instance.
+ * @param value - The string to upload.
+ * @param format - The format of the string to upload ('raw' | 'base64' | 'base64url' | 'data_url'). Optional.
+ * @param metadata - A Storage `SettableMetadata` instance to update. Optional.
+ * @returns {Task}
+ */
+export function uploadString(storageRef, data, format, metadata) {
+  return storageRef.putString(data, format, metadata);
+}
+
+// Methods not on the Firebase JS SDK below
+
+/**
+ *  Returns a new Storage `Reference` instance from a storage bucket URL.
+ * @param storage - Storage instance.
+ * @param url - A storage bucket URL pointing to a single file or location. Must be either a `gs://` url or an `http` url. Not available on web.
+ * @returns {Reference}
+ */
+export function refFromURL(storage, url) {
+  return storage.refFromURL(url);
+}
+
+/**
+ * Sets the maximum time in milliseconds to retry a download if a failure occurs.. android & iOS only.
+ * @param storage - Storage instance.
+ * @param time - The new maximum operation retry time in milliseconds.
+ * @returns {Promise<void>}
+ */
+export function setMaxOperationRetryTime(storage, time) {
+  return storage.setMaxOperationRetryTime(time);
+}
+
+/**
+ * Sets the maximum time in milliseconds to retry an upload if a failure occurs. android & iOS only.
+ * @param storage - Storage instance.
+ * @param time - The new maximum operation retry time in milliseconds.
+ * @returns {Promise<void>}
+ */
+export function setMaxUploadRetryTime(storage, time) {
+  return storage.setMaxUploadRetryTime(time);
+}
+
+/**
+ * Puts a file from local disk onto the storage bucket.
+ * @param storageRef - Storage Reference instance.
+ * @param localFilePath The local file path to upload to the bucket at the reference location.
+ * @param metadata Any additional `SettableMetadata` for this task.
+ * @returns {Task}
+ */
+export function putFile(storageRef, filePath, metadata) {
+  return storageRef.putFile(filePath, metadata);
+}
+
+/**
+ * Downloads a file to the specified local file path on the device.
+ * @param storageRef - Storage Reference instance.
+ * @param localFilePath The local file path to upload to on the device.
+ * @returns {Task}
+ */
+export function writeToFile(storageRef, filePath) {
+  return storageRef.writeToFile(filePath);
+}
+
+/**
+ * Returns a gs:// URL for this object in the form `gs://<bucket>/<path>/<to>/<object>`.
+ * @param storageRef - Storage Reference instance.
+ * @returns {String}
+ */
+export function toString(storageRef) {
+  return storageRef.toString();
+}
+
+/**
+ * Returns a reference to a relative path from this reference.
+ * @param storageRef - Storage Reference instance.
+ * @param path - The relative path from this reference. Leading, trailing, and consecutive slashes are removed.
+ * @returns {String}
+ */
+export function child(storageRef, path) {
+  return storageRef.child(path);
+}
+
+/**
+ * Sets the maximum time in milliseconds to retry a download if a failure occurs.
+ * @param storage - Storage instance.
+ * @param time - The new maximum download retry time in milliseconds.
+ * @returns {Promise<void>}
+ */
+export function setMaxDownloadRetryTime(storage, time) {
+  return storage.setMaxDownloadRetryTime(time);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/storage",
-  "version": "17.3.1",
+  "version": "17.4.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - React Native Firebase provides native integration with Cloud Storage, providing support to upload and download files directly from your device and from your Firebase Cloud Storage bucket.",
   "main": "lib/index.js",
@@ -29,10 +29,10 @@
     "download"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "17.3.1"
+    "@react-native-firebase/app": "17.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8c57bbb3d9c397fc472b78e9853b671ed41e30ca"
+  "gitHead": "2a79509bb34278bf9919aceeb58a6ef74ab36520"
 }