how can I delete a folder? #757

Author: EddyVerbruggen

README.md

@@ -1,6 +1,5 @@
 # NativeScript Firebase plugin
 
-[![Build Status][build-status]][build-url]
 [![NPM version][npm-image]][npm-url]
 [![Downloads][downloads-image]][npm-url]
 [![Twitter Follow][twitter-image]][twitter-url]

demo/app/main-page.xml

@@ -18,7 +18,7 @@
       <TabViewItem.view>
         <ScrollView>
           <GridLayout columns="*, *"
-                      rows="auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto"
+                      rows="auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto"
                       horizontalAlignment="stretch"
                       class="tab-content">
             <Button row="0" colSpan="2" text="init firebase - do this first" tap="{{ doWebInit }}" class="button button-positive"/>
@@ -62,6 +62,16 @@
             <Label row="15" col="0" text="Value:" class="message"/>
             <Label row="15" col="1" text="{{ value }}" class="message" textWrap="true"/>
 
+            <Label row="16" colSpan="2" text="Google Cloud Storage" class="subtitle"/>
+
+            <Button row="17" col="0" text="upload file" tap="{{ doWebUploadFile }}" class="button button-storage"/>
+            <Button row="17" col="1" text="download file" tap="{{ doWebDownloadFile }}" class="button button-storage"/>
+
+            <Button row="18" col="0" text="get download url" tap="{{ doWebGetDownloadUrl }}" class="button button-storage"/>
+            <Button row="18" col="1" text="delete remote file" tap="{{ doWebDeleteFile }}" class="button button-storage"/>
+
+            <Label row="19" colSpan="2" text="{{ storageFeedback }}" class="message" textWrap="true"/>
+
           </GridLayout>
         </ScrollView>
       </TabViewItem.view>

demo/app/main-view-model.ts

@@ -5,7 +5,8 @@ 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 * as firebase from "nativescript-plugin-firebase";
+
 const firebaseWebApi = require("nativescript-plugin-firebase/app");
 
 declare const Crashlytics: any;
@@ -58,7 +59,9 @@ export class HelloWorldModel extends Observable {
   }
 
   public doWebInit(): void {
-    firebaseWebApi.initializeApp();
+    firebaseWebApi.initializeApp({
+      storageBucket: 'gs://n-plugin-test.appspot.com',
+    });
   }
 
   public doWebLoginAnonymously(): void {
@@ -307,6 +310,76 @@ export class HelloWorldModel extends Observable {
     });
   }
 
+  public doWebUploadFile(): void {
+    // let's first create a File object using the tns file module
+    const appPath = fs.knownFolders.currentApp().path;
+    const logoPath = appPath + "/images/telerik-logo.png";
+
+    const storageRef = firebaseWebApi.storage().ref();
+    const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+    childRef.put(fs.File.fromPath(logoPath)).then(
+        uploadedFile => {
+          console.log("Uploaded! " + JSON.stringify(uploadedFile));
+          this.set("storageFeedback", "Uploaded!");
+        },
+        error => {
+          console.log("firebase.doWebUploadFile error: " + error);
+          this.set("storageFeedback", "Error: " + error);
+        }
+    );
+  }
+
+  public doWebDownloadFile(): void {
+    const storageRef = firebaseWebApi.storage().ref();
+    const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+    // let's first determine where we'll create the file using the 'file-system' module
+    const documents = fs.knownFolders.documents();
+    const logoPath = documents.path + "/telerik-logo-downloaded.png";
+
+    childRef.download(logoPath)
+        .then(() => {
+          console.log("The file has been downloaded");
+          this.set("storageFeedback", "The file has been downloaded");
+        })
+        .catch(error => {
+          console.log("Download error: " + error);
+          this.set("storageFeedback", "Error: " + error);
+        });
+  }
+
+  public doWebGetDownloadUrl(): void {
+    const storageRef = firebaseWebApi.storage().ref();
+    const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+    childRef.getDownloadURL()
+        .then(theUrl => {
+          console.log("Download url: " + theUrl);
+          this.set("storageFeedback", "Download URL: " + theUrl);
+        })
+        .catch(error => {
+          console.log("Download error: " + error);
+          this.set("storageFeedback", "Error: " + error);
+        });
+  }
+
+  public doWebDeleteFile(): void {
+    const storageRef = firebaseWebApi.storage().ref();
+    const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+    childRef.delete().then(
+        () => {
+          console.log("Deleted file");
+          this.set("storageFeedback", "File deleted");
+        },
+        error => {
+          console.log("Error deleting file: " + error);
+          this.set("storageFeedback", "Error deleting file: " + error);
+        }
+    );
+  }
+
 
   /***********************************************
    * Native API usage examples
@@ -1376,6 +1449,27 @@ export class HelloWorldModel extends Observable {
     );
   }
 
+  public doDeleteFile(): void {
+    firebase.deleteFile({
+      remoteFullPath: 'uploads/images/telerik-logo-uploaded.png'
+    }).then(
+        theUrl => {
+          alert({
+            title: "File deleted",
+            message: "Enjoy your day!",
+            okButtonText: "Thanks ;)"
+          });
+        },
+        error => {
+          alert({
+            title: "File deletion error",
+            message: error,
+            okButtonText: "OK"
+          });
+        }
+    );
+  }
+
   public doReauthenticatePwdUser(): void {
     firebase.reauthenticate({
       type: firebase.LoginType.PASSWORD,
@@ -1440,27 +1534,6 @@ export class HelloWorldModel extends Observable {
     );
   }
 
-  public doDeleteFile(): void {
-    firebase.deleteFile({
-      remoteFullPath: 'uploads/images/telerik-logo-uploaded.png'
-    }).then(
-        theUrl => {
-          alert({
-            title: "File deleted",
-            message: "Enjoy your day!",
-            okButtonText: "Thanks ;)"
-          });
-        },
-        error => {
-          alert({
-            title: "File deletion error",
-            message: error,
-            okButtonText: "OK"
-          });
-        }
-    );
-  }
-
   public doSubscribeToTopic(): void {
     firebase.subscribeToTopic("demo").then(
         () => {

docs/STORAGE.md

@@ -20,21 +20,40 @@ You can either pass it to the `init()` function as shown below,
 or pass it as a property any time you're using a storage feature.
 In theory the former is a little more efficient because it's cached by the plugin.
 
+> Should I use the *Native API* or the *Web API*? Whichever syntax you like most - the underlying implementation is the same.
+ 
+<details>
+ <summary>Native API</summary>
+
 ```js
   firebase.init({
     storageBucket: 'gs://n-plugin-test.appspot.com'
     // any other options
   });
 ```
+</details>
+
+<details>
+ <summary>Web API</summary>
+
+```js
+  firebaseWebApi.initializeApp({
+    storageBucket: 'gs://n-plugin-test.appspot.com'
+  });
+```
+</details>
 
 ## Functions
 
 ### uploadFile
 You can either pass in a full local path to a file, or (as a convenience) use the `file-system` module that comes shipped with {N} as standard.
 
+<details>
+ <summary>Native API</summary>
+
 ```js
   // init the file-system module
-  var fs = require("file-system");
+  var fs = require("tns-core-modules/file-system");
 
   // grab a reference to the app folder
   var appPath = fs.knownFolders.currentApp().path;
@@ -66,15 +85,41 @@ You can either pass in a full local path to a file, or (as a convenience) use th
       }
   );
 ```
+</details>
+
+<details>
+ <summary>Web API</summary>
+
+#### TypeScript
+
+```typescript
+  import * as fs from "tns-core-modules/file-system";
+
+  // let's first create a File object using the tns file module
+  const appPath = fs.knownFolders.currentApp().path;
+  const logoPath = appPath + "/images/telerik-logo.png";
+
+  const storageRef = firebaseWebApi.storage().ref();
+  const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+  childRef.put(fs.File.fromPath(logoPath)).then(
+      uploadedFile => console.log("Uploaded! " + JSON.stringify(uploadedFile)),
+      error => console.log("firebase.doWebUploadFile error: " + error)
+  );
+```
+</details>
 
 ### downloadFile
 As with `uploadFile` you can either pass in a full local path to a file, or (as a convenience) use the `file-system` module that comes shipped with {N} as standard.
 
 In this example we'll download the previously uploaded file to a certain path on the local filesystem.
 
+<details>
+ <summary>Native API</summary>
+
 ```js
   // init the file-system module
-  var fs = require("file-system");
+  var fs = require("tns-core-modules/file-system");
 
   // let's first determine where we'll create the file using the 'file-system' module
   var documents = fs.knownFolders.documents();
@@ -102,12 +147,37 @@ In this example we'll download the previously uploaded file to a certain path on
       }
   );
 ```
+</details>
+
+<details>
+ <summary>Web API</summary>
+
+#### TypeScript
+
+```typescript
+  import * as fs from "tns-core-modules/file-system";
+
+  const storageRef = firebaseWebApi.storage().ref();
+  const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+  // let's first determine where we'll create the file using the 'file-system' module
+  const documents = fs.knownFolders.documents();
+  const logoPath = documents.path + "/telerik-logo-downloaded.png";
+
+  childRef.download(logoPath)
+      .then(() => console.log("The file has been downloaded"))
+      .catch(error => console.log("Download error: " + error));
+```
+</details>
 
 ### getDownloadUrl
 If you just want to know the remote URL of a file in remote storage so you can either share it or download the file by any other means than `downloadFile` then use this method.
 
 In this example we'll determine the remote URL of the previously uploaded file.
 
+<details>
+ <summary>Native API</summary>
+
 ```js
   firebase.getDownloadUrl({
     // optional, can also be passed during init() as 'storageBucket' param so we can cache it
@@ -123,10 +193,29 @@ In this example we'll determine the remote URL of the previously uploaded file.
       }
   );
 ```
+</details>
+
+<details>
+ <summary>Web API</summary>
+
+#### TypeScript
+
+```typescript
+  const storageRef = firebaseWebApi.storage().ref();
+  const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+  childRef.getDownloadURL()
+      .then(theUrl => console.log("Download url: " + theUrl))
+      .catch(error => console.log("Download error: " + error));
+```
+</details>
 
 ### deleteFile
 You can pass in remote file path to delete it.
 
+<details>
+ <summary>Native API</summary>
+
 ```js
   firebase.deleteFile({
     // optional, can also be passed during init() as 'storageBucket' param so we can cache it
@@ -142,3 +231,20 @@ You can pass in remote file path to delete it.
       }
   );
 ```
+</details>
+
+<details>
+ <summary>Web API</summary>
+
+#### TypeScript
+
+```typescript
+  const storageRef = firebaseWebApi.storage().ref();
+  const childRef = storageRef.child("uploads/images/telerik-logo-uploaded.png");
+
+  childRef.delete().then(
+      () => console.log("Deleted file"),
+      error => console.log("Error deleting file: " + error)
+      );
+```
+</details>

src/app/index.ts

@@ -7,6 +7,7 @@ import * as firebase from "../firebase";
 import { auth as firebaseAuthModule } from "./auth";
 import { database as firebaseDatabaseModule } from "./database";
 import { firestore as firebaseFirestoreModule } from "./firestore";
+import { storage as firebaseStorageModule } from "./storage";
 
 export function initializeApp(options?: firebase.InitOptions, name? /* ignored */: string): Promise<any> {
   return firebase.init(options);
@@ -23,7 +24,6 @@ export function auth(app?: any): firebaseAuthModule.Auth {
   return authCache;
 }
 
-
 let dbCache;
 export function database(app?: any): firebaseDatabaseModule.Database {
   if (app) {
@@ -35,7 +35,6 @@ export function database(app?: any): firebaseDatabaseModule.Database {
   return dbCache;
 }
 
-
 let firestoreCache;
 export function firestore(app?: any): firebaseFirestoreModule.Firestore {
   if (app) {
@@ -46,3 +45,14 @@ export function firestore(app?: any): firebaseFirestoreModule.Firestore {
   }
   return firestoreCache;
 }
+
+let storageCache;
+export function storage(app?: any): firebaseStorageModule.Storage {
+  if (app) {
+    console.log("The 'app' param is ignored at the moment.");
+  }
+  if (!storageCache) {
+    storageCache = new firebaseStorageModule.Storage();
+  }
+  return storageCache;
+}