Increment Feature in Firestore. #1225

Author: EddyVerbruggen

CHANGELOG.md

@@ -3,6 +3,10 @@
 - [Firebase iOS SDK Changelog](https://firebase.google.com/support/release-notes/ios)
 - [Firebase Android SDK Changelog](https://firebase.google.com/support/release-notes/android)
 
+## 8.3.0 (2019, April ?)
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/99?closed=1)
+
+
 ## 8.2.0 (2019, April 10)
 [Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/98?closed=1)
 

demo-ng/app/tabs/firestore/firestore.component.ts

@@ -246,6 +246,7 @@ export class FirestoreComponent {
           updateTs: firebase.firestore().FieldValue().serverTimestamp(),
           // just fyi - both of these work:
           colors: firestore.FieldValue.arrayUnion("red", "blue"),
+          ageInt: firebase.firestore().FieldValue().increment(2),
           messages: firebase.firestore().FieldValue().arrayUnion({
             message: "Test 1",
             source: "central",
@@ -262,6 +263,7 @@ export class FirestoreComponent {
           last: "Updated From 'arrayRemove'",
           updateTs: firebase.firestore().FieldValue().serverTimestamp(),
           colors: firestore.FieldValue.arrayUnion("red"),
+          ageDouble: firebase.firestore().FieldValue().increment(1.1),
           messages: firebase.firestore().FieldValue().arrayRemove({
             message: "Test 1",
             source: "central",

docs/FIRESTORE.md

@@ -6,7 +6,7 @@ During plugin installation you'll be asked whether or not you use Firestore.
 In case you're upgrading and you have the `firebase.nativescript.json` file in your project root, edit it and add: `"firestore": true`.
 Then run `rm -rf platforms && rm -rf node_modules && npm i`.
 
-## Functions
+## API
 All of these are 100% compatible with the Firestore Web API to make it easy to share code between web and native, and you can
 refer to the [Firestore web api docs](https://firebase.google.com/docs/firestore/data-model) (make sure to look at the 'WEB' tab of those code samples).
 
@@ -268,7 +268,7 @@ sanFranciscoDocument.delete().then(() => {
 To delete one or more fields in a document, do this (showing two flavors, use whatever you fancy):
 
 ```typescript
-import { firestore } from "nativescript-plugin-firebase");
+import { firestore } from "nativescript-plugin-firebase";
 const firebase = require("nativescript-plugin-firebase/app");
 
 firebase.firestore().collection("dogs").doc("fave")
@@ -278,6 +278,20 @@ firebase.firestore().collection("dogs").doc("fave")
     });
 ```
 
+### Increment numbers
+To easily increment numbers (`int` or `float`), you can use the `increment` feature since plugin version 8.3.0.
+
+```typescript
+import { firestore } from "nativescript-plugin-firebase";
+const firebase = require("nativescript-plugin-firebase/app");
+
+firebase.firestore().collection("dogs").doc("fave")
+    .update({
+      age: firestore.FieldValue.increment(1),
+      lifePercentage: firebase.firestore().FieldValue().increment(0.0027),
+    });
+```
+
 ### Adding to (`arrayUnion`) and removing from (`arrayRemove`) Arrays
 If your document contains an array field, you can use `arrayUnion()` and `arrayRemove()` to add and remove elements.
 

src/app/firestore/index.ts

@@ -18,7 +18,8 @@ export namespace firestore {
         serverTimestamp: () => "SERVER_TIMESTAMP",
         delete: () => "DELETE_FIELD",
         arrayUnion: (...elements: any[]) => new firebase.firestore.FieldValue("ARRAY_UNION", elements),
-        arrayRemove: (...elements: any[]) => new firebase.firestore.FieldValue("ARRAY_REMOVE", elements)
+        arrayRemove: (...elements: any[]) => new firebase.firestore.FieldValue("ARRAY_REMOVE", elements),
+        increment: (n: number) => new firebase.firestore.FieldValue("INCREMENT", n)
       };
     }
 

src/firebase-common.ts

@@ -18,6 +18,7 @@ export class FieldValue {
   static delete = () => "DELETE_FIELD";
   static arrayUnion = (...elements: any[]) => new FieldValue("ARRAY_UNION", elements);
   static arrayRemove = (...elements: any[]) => new FieldValue("ARRAY_REMOVE", elements);
+  static increment = (n: number) => new firebase.firestore.FieldValue("INCREMENT", n);
 }
 
 export class GeoPoint {

src/firebase.android.ts

@@ -150,6 +150,8 @@ firebase.toHashMap = obj => {
             let values: Array<any> = Array.isArray(fieldValue.value[0]) ? fieldValue.value[0] : fieldValue.value;
             values = values.map(v => typeof (v) === "object" ? firebase.toHashMap(v) : v);
             node.put(property, com.google.firebase.firestore.FieldValue.arrayRemove(values));
+          } else if (fieldValue.type === "INCREMENT") {
+            node.put(property, com.google.firebase.firestore.FieldValue.increment(fieldValue.value));
           } else {
             console.log("You found a bug! Please report an issue at https://github.com/EddyVerbruggen/nativescript-plugin-firebase/issues, mention fieldValue.type = '" + fieldValue.type + "'. Thanks!");
           }

src/firebase.d.ts

@@ -903,7 +903,7 @@ export namespace firestore {
     commit(): Promise<void>;
   }
 
-  export type FieldValueType = "ARRAY_UNION" | "ARRAY_REMOVE";
+  export type FieldValueType = "ARRAY_UNION" | "ARRAY_REMOVE" | "INCREMENT";
 
   export class FieldValue {
     constructor(type: FieldValueType, value: any);
@@ -912,6 +912,7 @@ export namespace firestore {
     static delete: () => "DELETE_FIELD";
     static arrayUnion: (...elements: any[]) => FieldValue;
     static arrayRemove: (...elements: any[]) => FieldValue;
+    static increment: (n: number) => FieldValue;
   }
 
   export interface SnapshotListenOptions {

src/firebase.ios.ts

@@ -2178,6 +2178,13 @@ function fixSpecialField(item): any {
       return FIRFieldValue.fieldValueForArrayUnion(Array.isArray(fieldValue.value[0]) ? fieldValue.value[0] : fieldValue.value);
     } else if (fieldValue.type === "ARRAY_REMOVE") {
       return FIRFieldValue.fieldValueForArrayRemove(Array.isArray(fieldValue.value[0]) ? fieldValue.value[0] : fieldValue.value);
+    } else if (fieldValue.type === "INCREMENT") {
+      const isInt = fieldValue.value % 1 === 0;
+      if (isInt) {
+        return FIRFieldValue.fieldValueForIntegerIncrement(fieldValue.value);
+      } else {
+        return FIRFieldValue.fieldValueForDoubleIncrement(fieldValue.value);
+      }
     } else {
       console.log("You found a bug! Please report an issue at https://github.com/EddyVerbruggen/nativescript-plugin-firebase/issues, mention fieldValue.type = '" + fieldValue.type + "'. Thanks!");
     }