Extract storage-related functions into a new separate module #761

Author: EddyVerbruggen

.gitignore

@@ -16,6 +16,7 @@ src/platforms/android/include.gradle
 !src/index.d.ts
 !src/references.d.ts
 !src/analytics/analytics.d.ts
+!src/storage/storage.d.ts
 !src/mlkit/*/index.d.ts
 !src/mlkit/mlkit-cameraview.d.ts
 !src/platforms/web/typings/firebase-webapi.d.ts

demo/app/main-view-model.ts

@@ -2,10 +2,9 @@ import { Observable } from "tns-core-modules/data/observable";
 import { alert, prompt } from "tns-core-modules/ui/dialogs";
 import { ios as iosUtils } from "tns-core-modules/utils/utils";
 import { isIOS } from "tns-core-modules/platform";
-import { AddEventListenerResult, User } from "nativescript-plugin-firebase";
-import * as fs from "tns-core-modules/file-system";
-
 import * as firebase from "nativescript-plugin-firebase";
+import { AddEventListenerResult, storage as firebaseStorage, User } from "nativescript-plugin-firebase";
+import * as fs from "tns-core-modules/file-system";
 
 const firebaseWebApi = require("nativescript-plugin-firebase/app");
 
@@ -356,7 +355,7 @@ export class HelloWorldModel extends Observable {
     childRef.getDownloadURL()
         .then(theUrl => {
           console.log("Download url: " + theUrl);
-          this.set("storageFeedback", "Download URL: " + theUrl);
+          this.set("storageFeedback", "Download URL logged to the console");
         })
         .catch(error => {
           console.log("Download error: " + error);
@@ -1374,7 +1373,7 @@ export class HelloWorldModel extends Observable {
     const appPath = fs.knownFolders.currentApp().path;
     const logoPath = appPath + "/images/telerik-logo.png";
 
-    firebase.uploadFile({
+    firebaseStorage.uploadFile({
       remoteFullPath: 'uploads/images/telerik-logo-uploaded.png',
       localFile: fs.File.fromPath(logoPath), // use this (a file-system module File object)
       // localFullPath: logoPath, // or this, a full file path
@@ -1403,7 +1402,7 @@ export class HelloWorldModel extends Observable {
     // this will create or overwrite a local file in the app's documents folder
     const localLogoFile = documents.getFile("telerik-logo-downloaded.png");
 
-    firebase.downloadFile({
+    firebaseStorage.downloadFile({
       remoteFullPath: 'uploads/images/telerik-logo-uploaded.png',
       // localFile: localLogoFile // use this (a file-system module File object)
       localFullPath: logoPath // or this, a full file path
@@ -1426,7 +1425,7 @@ export class HelloWorldModel extends Observable {
   }
 
   public doGetDownloadUrl(): void {
-    firebase.getDownloadUrl({
+    firebaseStorage.getDownloadUrl({
       remoteFullPath: 'uploads/images/telerik-logo-uploaded.png'
     }).then(
         theUrl => {
@@ -1448,7 +1447,7 @@ export class HelloWorldModel extends Observable {
   }
 
   public doDeleteFile(): void {
-    firebase.deleteFile({
+    firebaseStorage.deleteFile({
       remoteFullPath: 'uploads/images/telerik-logo-uploaded.png'
     }).then(
         theUrl => {

docs/STORAGE.md

@@ -1,5 +1,6 @@
 <img src="https://raw.githubusercontent.com/EddyVerbruggen/nativescript-plugin-firebase/master/docs/images/features/storage.png" height="85px" alt="Storage"/>
 
+> NOTE: since plugin version 6.2.0 you have to use `firebase.storage.xxx` instead of `firebase.xxx`, because I've extracted storage-related functions into a separate module.
 
 ## Enabling Storage
 Since plugin version 3.4.0 you can use Firebase _Storage_ features.
@@ -62,7 +63,7 @@ You can either pass in a full local path to a file, or (as a convenience) use th
   var logoPath = appPath + "/res/telerik-logo.png";
 
   // now upload the file with either of the options below:
-  firebase.uploadFile({
+  firebase.storage.uploadFile({
     // optional, can also be passed during init() as 'storageBucket' param so we can cache it (find it in the Firebase console)
     bucket: 'gs://n-plugin-test.appspot.com',
     // the full path of the file in your Firebase storage (folders will be created)
@@ -129,7 +130,7 @@ In this example we'll download the previously uploaded file to a certain path on
   var localLogoFile = documents.getFile("telerik-logo-downloaded.png");
 
   // now download the file with either of the options below:
-  firebase.downloadFile({
+  firebase.storage.downloadFile({
     // optional, can also be passed during init() as 'storageBucket' param so we can cache it
     bucket: 'gs://n-plugin-test.appspot.com',
     // the full path of an existing file in your Firebase storage
@@ -179,7 +180,7 @@ In this example we'll determine the remote URL of the previously uploaded file.
  <summary>Native API</summary>
 
 ```js
-  firebase.getDownloadUrl({
+  firebase.storage.getDownloadUrl({
     // optional, can also be passed during init() as 'storageBucket' param so we can cache it
     bucket: 'gs://n-plugin-test.appspot.com',
     // the full path of an existing file in your Firebase storage
@@ -217,7 +218,7 @@ You can pass in remote file path to delete it.
  <summary>Native API</summary>
 
 ```js
-  firebase.deleteFile({
+  firebase.storage.deleteFile({
     // optional, can also be passed during init() as 'storageBucket' param so we can cache it
     bucket: 'gs://n-plugin-test.appspot.com',
     // the full path of an existing file in your Firebase storage

src/app/storage/index.ts

@@ -1,6 +1,6 @@
-import * as firebase from "../../firebase";
-import { UploadFileResult } from "../../firebase";
 import { File } from "tns-core-modules/file-system"
+import * as firebaseStorage from "../../storage/storage";
+import { UploadFileResult } from "../../storage/storage";
 
 export module storage {
 
@@ -32,20 +32,20 @@ export module storage {
     }
 
     delete(): Promise<void> {
-      return firebase.deleteFile({
+      return firebaseStorage.deleteFile({
         remoteFullPath: this.path
       });
     }
 
     getDownloadURL(): Promise<string> {
-      return firebase.getDownloadUrl({
+      return firebaseStorage.getDownloadUrl({
         remoteFullPath: this.path
       });
     }
 
     public put(data: File | string /* path */, metadata?: any /* ignored */): Promise<UploadTaskSnapshot> {
       return new Promise((resolve, reject) => {
-        firebase.uploadFile({
+        firebaseStorage.uploadFile({
           localFile: data instanceof File ? data : undefined,
           localFullPath: !(data instanceof File) ? data : undefined,
           remoteFullPath: this.path,
@@ -64,7 +64,7 @@ export module storage {
 
     // Note that this is not part of the web API, but prolly super convenient ;)
     public download(downloadToPath: string): Promise<any> {
-      return firebase.downloadFile({
+      return firebaseStorage.downloadFile({
         localFullPath: downloadToPath,
         remoteFullPath: this.path
       });

src/firebase-common.ts

@@ -2,6 +2,7 @@ import { prompt } from "tns-core-modules/ui/dialogs";
 import { getString, setString } from "tns-core-modules/application-settings";
 import { firestore } from "./firebase";
 import * as analytics from "./analytics/analytics";
+import * as storage from "./storage/storage";
 import * as mlkit from "./mlkit";
 
 // note that this implementation is overridden for iOS
@@ -12,12 +13,12 @@ export class FieldValue {
 export const firebase: any = {
   initialized: false,
   instance: null,
-  storage: null,
   firebaseRemoteConfig: null,
   authStateListeners: [],
   _receivedNotificationCallback: null,
   _dynamicLinkCallback: null,
   analytics,
+  storage,
   mlkit,
   firestore: {
     FieldValue