Update Firebase Android SDK versions for ML Kit and Firestore (Aug 13 update) #853

EddyVerbruggen · EddyVerbruggen · commit c001bfe69f82 · 2018-08-15T23:57:45.000+02:00
diff --git a/demo-ng/app/App_Resources/Android/AndroidManifest.xml b/demo-ng/app/App_Resources/Android/AndroidManifest.xml
@@ -36,7 +36,7 @@
 
 		<meta-data
 				android:name="com.google.firebase.ml.vision.DEPENDENCIES"
-				android:value="text,barcode,face,label" />
+				android:value="ocr,barcode,face,label" />
 
 		<activity
 			android:name="com.tns.NativeScriptActivity"
diff --git a/demo-ng/app/tabs/mlkit/mlkit.component.ts b/demo-ng/app/tabs/mlkit/mlkit.component.ts
@@ -10,10 +10,7 @@ import * as Camera from "nativescript-camera";
 import { BarcodeFormat, MLKitScanBarcodesOnDeviceResult } from "nativescript-plugin-firebase/mlkit/barcodescanning";
 import { MLKitLandmarkRecognitionCloudResult } from "nativescript-plugin-firebase/mlkit/landmarkrecognition";
 import { MLKitDetectFacesOnDeviceResult } from "nativescript-plugin-firebase/mlkit/facedetection";
-import {
-  MLKitRecognizeTextCloudResult,
-  MLKitRecognizeTextOnDeviceResult
-} from "nativescript-plugin-firebase/mlkit/textrecognition";
+import { MLKitRecognizeTextResult } from "nativescript-plugin-firebase/mlkit/textrecognition";
 import {
   MLKitImageLabelingCloudResult,
   MLKitImageLabelingOnDeviceResult
@@ -102,7 +99,7 @@ export class MLKitComponent {
       width: 800,
       height: 800,
       keepAspectRatio: true,
-      saveToGallery: false,
+      saveToGallery: true,
       cameraFacing: "rear"
     }).then(imageAsset => {
       new ImageSource().fromAsset(imageAsset).then(imageSource => {
@@ -182,19 +179,20 @@ export class MLKitComponent {
         this.labelImageCloud(imageSource);
       } else if (pickedItem === "Landmark recognition (cloud)") {
         this.recognizeLandmarkCloud(imageSource);
-      // } else if (pickedItem === "Custom model (on device)") {
-      //   this.customModelOnDevice(imageSource);
+        // } else if (pickedItem === "Custom model (on device)") {
+        //   this.customModelOnDevice(imageSource);
       }
     });
   }
 
   private recognizeTextOnDevice(imageSource: ImageSource): void {
     firebase.mlkit.textrecognition.recognizeTextOnDevice({
       image: imageSource
-    }).then((result: MLKitRecognizeTextOnDeviceResult) => {
+    }).then((result: MLKitRecognizeTextResult) => {
+      console.log("recognizeTextOnDevice result: " + JSON.stringify(result));
       alert({
         title: `Result`,
-        message: result.blocks.map(block => block.text).join(""),
+        message: result.text ? result.text : "",
         okButtonText: "OK"
       });
     }).catch(errorMessage => console.log("ML Kit error: " + errorMessage));
@@ -206,10 +204,11 @@ export class MLKitComponent {
       modelType: "latest",
       maxResults: 15
     }).then(
-        (result: MLKitRecognizeTextCloudResult) => {
+        (result: MLKitRecognizeTextResult) => {
+          console.log("recognizeTextCloud result: " + JSON.stringify(result));
           alert({
             title: `Result`,
-            message: result.text,
+            message: result.text ? result.text : "",
             okButtonText: "OK"
           });
         })
diff --git a/demo-ng/app/tabs/mlkit/textrecognition/textrecognition.component.ts b/demo-ng/app/tabs/mlkit/textrecognition/textrecognition.component.ts
@@ -1,6 +1,6 @@
 import { Component } from "@angular/core";
 import {
-  MLKitRecognizeTextOnDeviceResult,
+  MLKitRecognizeTextResult,
   MLKitRecognizeTextResultBlock
 } from "nativescript-plugin-firebase/mlkit/textrecognition";
 
@@ -13,7 +13,7 @@ export class TextRecognitionComponent {
   blocks: Array<MLKitRecognizeTextResultBlock>;
 
   onTextRecognitionResult(scanResult: any): void {
-    const value: MLKitRecognizeTextOnDeviceResult = scanResult.value;
+    const value: MLKitRecognizeTextResult = scanResult.value;
     this.blocks = value.blocks;
   }
 }
diff --git a/docs/ML_KIT.md b/docs/ML_KIT.md
@@ -46,11 +46,11 @@ after your app is installed from the Play Store. Add this to your `<resources>/A
 ```xml
 <meta-data
     android:name="com.google.firebase.ml.vision.DEPENDENCIES"
-    android:value="text,face,.." />
+    android:value="ocr,face,.." />
 ```
 
-Replace `text,label,..` by whichever features you need. So if you only need Text recognitions, use `"text"`, but if you want
-to perform Text recognition, Face detection, Barcode scanning, and Image labeling on-device, use `"text,face,barcode,label"`.
+Replace `ocr,label,..` by whichever features you need. So if you only need Text recognitions, use `"ocr"`, but if you want
+to perform Text recognition, Face detection, Barcode scanning, and Image labeling on-device, use `"ocr,face,barcode,label"`.
 
 Note that (because of how iOS works) we bundle the models you've picked during plugin configuration with your app.
 So if you have a change of heart, re-run the configuration as explained at the top of this document. 
@@ -91,26 +91,26 @@ To be able to use Cloud features you need to do two things:
 #### Still image (on-device)
 
 ```typescript
-import { MLKitRecognizeTextOnDeviceResult } from "nativescript-plugin-firebase/mlkit/textrecognition";
+import { MLKitRecognizeTextResult } from "nativescript-plugin-firebase/mlkit/textrecognition";
 const firebase = require("nativescript-plugin-firebase");
 
 firebase.mlkit.textrecognition.recognizeTextOnDevice({
   image: imageSource // a NativeScript Image or ImageSource, see the demo for examples
-}).then((result: MLKitRecognizeTextOnDeviceResult) => { // just look at this type to see what else is returned
-  console.log(result.blocks.map(block => block.text).join(""));
+}).then((result: MLKitRecognizeTextResult) => { // just look at this type to see what else is returned
+  console.log(result.text ? result.text : "");
 }).catch(errorMessage => console.log("ML Kit error: " + errorMessage));
 ```
 
 #### Still image (cloud)
 
 ```typescript
-import { MLKitRecognizeTextCloudResult } from "nativescript-plugin-firebase/mlkit/textrecognition";
+import { MLKitRecognizeTextResult } from "nativescript-plugin-firebase/mlkit/textrecognition";
 const firebase = require("nativescript-plugin-firebase");
 
 firebase.mlkit.textrecognition.recognizeTextCloud({
   image: imageSource, // a NativeScript Image or ImageSource, see the demo for examples
 })
-.then((result: MLKitRecognizeTextCloudResult) => console.log(result.text))
+.then((result: MLKitRecognizeTextResult) => console.log(result.text ? result.text : ""))
 .catch(errorMessage => console.log("ML Kit error: " + errorMessage));
 ```
 
diff --git a/publish/scripts/installer.js b/publish/scripts/installer.js
@@ -239,7 +239,7 @@ function echoAndroidManifestChanges(result) {
     if (isSelected(result.ml_kit)) {
       var selectedFeatures = [];
       if (isSelected(result.ml_kit_text_recognition)) {
-        selectedFeatures.push("text");
+        selectedFeatures.push("ocr");
       }
       if (isSelected(result.ml_kit_barcode_scanning)) {
         selectedFeatures.push("barcode");
diff --git a/src/mlkit/mlkit-cameraview.android.ts b/src/mlkit/mlkit-cameraview.android.ts
@@ -185,10 +185,17 @@ export abstract class MLKitCameraView extends MLKitCameraViewBase {
 
           this.lastVisionImage = com.google.firebase.ml.vision.common.FirebaseVisionImage.fromByteBuffer(data, metadata);
 
-          this.detector
-              .detectInImage(this.lastVisionImage)
-              .addOnSuccessListener(onSuccessListener)
-              .addOnFailureListener(onFailureListener);
+          if (this.detector.processImage) {
+            this.detector
+                .processImage(this.lastVisionImage)
+                .addOnSuccessListener(onSuccessListener)
+                .addOnFailureListener(onFailureListener);
+          } else {
+            this.detector
+                .detectInImage(this.lastVisionImage)
+                .addOnSuccessListener(onSuccessListener)
+                .addOnFailureListener(onFailureListener);
+          }
         }
       }));
 
diff --git a/src/mlkit/textrecognition/index.android.ts b/src/mlkit/textrecognition/index.android.ts
@@ -1,32 +1,30 @@
 import { ImageSource } from "tns-core-modules/image-source";
 import { MLKitOptions, } from "../";
-import { MLKitRecognizeTextOnDeviceOptions, MLKitRecognizeTextOnDeviceResult } from "./";
+import { MLKitRecognizeTextOnDeviceOptions, MLKitRecognizeTextResult } from "./";
 import { MLKitTextRecognition as MLKitTextRecognitionBase } from "./textrecognition-common";
 import {
   MLKitRecognizeTextCloudOptions,
-  MLKitRecognizeTextCloudResult,
-  MLKitRecognizeTextResultBlock,
-  MLKitRecognizeTextResultLine,
+  MLKitRecognizeTextResultBounds,
   MLKitRecognizeTextResultElement,
-  MLKitRecognizeTextResultBounds
+  MLKitRecognizeTextResultLine
 } from "./index";
 
 declare const com: any;
 
 export class MLKitTextRecognition extends MLKitTextRecognitionBase {
 
-  protected createDetector(): any {
-    return com.google.firebase.ml.vision.FirebaseVision.getInstance().getVisionTextDetector();
+  protected createDetector(): any /* FirebaseVisionTextRecognizer */ {
+    return com.google.firebase.ml.vision.FirebaseVision.getInstance().getOnDeviceTextRecognizer();
   }
 
   protected createSuccessListener(): any {
     return new com.google.android.gms.tasks.OnSuccessListener({
-      onSuccess: textBlocks => {
-        if (textBlocks.getBlocks().size() > 0) {
+      onSuccess: firebaseVisionText => {
+        if (firebaseVisionText.getTextBlocks().size() > 0) {
           this.notify({
             eventName: MLKitTextRecognition.scanResultEvent,
             object: this,
-            value: getOnDeviceResult(textBlocks.getBlocks())
+            value: getResult(firebaseVisionText)
           });
         }
       }
@@ -48,17 +46,29 @@ function boundingBoxToBounds(rect: any): MLKitRecognizeTextResultBounds {
 }
 
 // see https://github.com/firebase/quickstart-android/blob/0f4c86877fc5f771cac95797dffa8bd026dd9dc7/mlkit/app/src/main/java/com/google/firebase/samples/apps/mlkit/textrecognition/TextRecognitionProcessor.java#L62
-function getOnDeviceResult(blocks: any): MLKitRecognizeTextOnDeviceResult {
-  const blks: MLKitRecognizeTextResultBlock[] = [];
+function getResult(firebaseVisionText: any): MLKitRecognizeTextResult {
+  if (firebaseVisionText === null) {
+    return {};
+  }
+
+  const result = <MLKitRecognizeTextResult>{ // TODO rename the return type
+    text: firebaseVisionText.getText(),
+    blocks: [],
+    android: firebaseVisionText
+  };
 
-  for (let i = 0; i < blocks.size(); i++) {
-    const block = blocks.get(i);
-    const lines = block.getLines();
+  for (let i = 0; i < firebaseVisionText.getTextBlocks().size(); i++) {
+    const textBlock = firebaseVisionText.getTextBlocks().get(i);
+    // const blockText: string = textBlock.getText();
+    // const blockConfidence: number = textBlock.getConfidence();
+    const lines = textBlock.getLines();
 
-    const lns:  MLKitRecognizeTextResultLine[] = [];
+    const lns: MLKitRecognizeTextResultLine[] = [];
 
     for (let j = 0; j < lines.size(); j++) {
       const line = lines.get(j);
+      // const lineText = line.getText();
+      // const lineConfidence = line.getConfidence();
       const elements = line.getElements();
 
       const elms: MLKitRecognizeTextResultElement[] = [];
@@ -78,36 +88,34 @@ function getOnDeviceResult(blocks: any): MLKitRecognizeTextOnDeviceResult {
       });
     }
 
-    blks.push({
-      text: block.getText(),
-      bounds: boundingBoxToBounds(block.getBoundingBox()),
+    result.blocks.push({
+      text: textBlock.getText(),
+      bounds: boundingBoxToBounds(textBlock.getBoundingBox()),
       lines: lns
     });
   }
 
-  return {
-    blocks: blks
-  };
+  return result;
 }
 
-export function recognizeTextOnDevice(options: MLKitRecognizeTextOnDeviceOptions): Promise<MLKitRecognizeTextOnDeviceResult> {
+export function recognizeTextOnDevice(options: MLKitRecognizeTextOnDeviceOptions): Promise<MLKitRecognizeTextResult> {
   return new Promise((resolve, reject) => {
     try {
-      const firebaseVisionTextDetector = com.google.firebase.ml.vision.FirebaseVision.getInstance().getVisionTextDetector();
+      const firebaseVisionTextRecognizer = com.google.firebase.ml.vision.FirebaseVision.getInstance().getOnDeviceTextRecognizer();
 
       const onSuccessListener = new com.google.android.gms.tasks.OnSuccessListener({
-        onSuccess: textBlocks => {
-          resolve(getOnDeviceResult(textBlocks.getBlocks()));
-          firebaseVisionTextDetector.close();
+        onSuccess: firebaseVisionText => {
+          resolve(getResult(firebaseVisionText));
+          firebaseVisionTextRecognizer.close();
         }
       });
 
       const onFailureListener = new com.google.android.gms.tasks.OnFailureListener({
         onFailure: exception => reject(exception.getMessage())
       });
 
-      firebaseVisionTextDetector
-          .detectInImage(getImage(options))
+      firebaseVisionTextRecognizer
+          .processImage(getImage(options))
           .addOnSuccessListener(onSuccessListener)
           .addOnFailureListener(onFailureListener);
 
@@ -118,32 +126,31 @@ export function recognizeTextOnDevice(options: MLKitRecognizeTextOnDeviceOptions
   });
 }
 
-export function recognizeTextCloud(options: MLKitRecognizeTextCloudOptions): Promise<MLKitRecognizeTextCloudResult> {
+export function recognizeTextCloud(options: MLKitRecognizeTextCloudOptions): Promise<MLKitRecognizeTextResult> {
   return new Promise((resolve, reject) => {
     try {
-      const cloudDetectorOptions =
+      const firebaseVisionCloudTextRecognizerOptions =
           new com.google.firebase.ml.vision.cloud.FirebaseVisionCloudDetectorOptions.Builder()
-              .setModelType(options.modelType === "latest" ? com.google.firebase.ml.vision.cloud.FirebaseVisionCloudDetectorOptions.LATEST_MODEL : com.google.firebase.ml.vision.cloud.FirebaseVisionCloudDetectorOptions.STABLE_MODEL)
-              .setMaxResults(options.maxResults || 10)
+          // TODO see 'setLanguageHints' at https://firebase.google.com/docs/ml-kit/android/recognize-text
+          // .setModelType(options.modelType === "latest" ? com.google.firebase.ml.vision.cloud.FirebaseVisionCloudDetectorOptions.LATEST_MODEL : com.google.firebase.ml.vision.cloud.FirebaseVisionCloudDetectorOptions.STABLE_MODEL)
+          // .setMaxResults(options.maxResults || 10)
               .build();
 
-      const firebaseVisionCloudTextDetector = com.google.firebase.ml.vision.FirebaseVision.getInstance().getVisionCloudTextDetector(cloudDetectorOptions);
+      const firebaseVisionCloudTextRecognizer = com.google.firebase.ml.vision.FirebaseVision.getInstance().getCloudTextRecognizer(firebaseVisionCloudTextRecognizerOptions);
 
       const onSuccessListener = new com.google.android.gms.tasks.OnSuccessListener({
-        onSuccess: firebaseVisionCloudText => {
-          resolve({
-            text: firebaseVisionCloudText ? firebaseVisionCloudText.getText() : null
-          });
-          firebaseVisionCloudTextDetector.close();
+        onSuccess: firebaseVisionText => {
+          resolve(getResult(firebaseVisionText));
+          firebaseVisionCloudTextRecognizer.close();
         }
       });
 
       const onFailureListener = new com.google.android.gms.tasks.OnFailureListener({
         onFailure: exception => reject(exception.getMessage())
       });
 
-      firebaseVisionCloudTextDetector
-          .detectInImage(getImage(options))
+      firebaseVisionCloudTextRecognizer
+          .processImage(getImage(options))
           .addOnSuccessListener(onSuccessListener)
           .addOnFailureListener(onFailureListener);
 
diff --git a/src/mlkit/textrecognition/index.d.ts b/src/mlkit/textrecognition/index.d.ts
@@ -28,16 +28,13 @@ export interface MLKitRecognizeTextResultBlock {
 	lines: Array<MLKitRecognizeTextResultLine>;
 }
 
-export interface MLKitRecognizeTextOnDeviceResult extends MLKitResult {
-	blocks: Array<MLKitRecognizeTextResultBlock>;
+export interface MLKitRecognizeTextResult extends MLKitResult {
+  text?: string;
+	blocks?: Array<MLKitRecognizeTextResultBlock>;
   ios?: any;
   android?: any;
 }
 
-export interface MLKitRecognizeTextCloudResult extends MLKitResult {
-  text: string;
-}
-
 // TODO see 'setLanguageHints' at https://firebase.google.com/docs/ml-kit/android/recognize-text
 
 export interface MLKitRecognizeTextOnDeviceOptions extends MLKitOptions {
@@ -46,9 +43,9 @@ export interface MLKitRecognizeTextOnDeviceOptions extends MLKitOptions {
 export interface MLKitRecognizeTextCloudOptions extends MLKitCloudOptions {
 }
 
-export declare function recognizeTextOnDevice(options: MLKitRecognizeTextOnDeviceOptions): Promise<MLKitRecognizeTextOnDeviceResult>;
+export declare function recognizeTextOnDevice(options: MLKitRecognizeTextOnDeviceOptions): Promise<MLKitRecognizeTextResult>;
 
-export declare function recognizeTextCloud(options: MLKitRecognizeTextCloudOptions): Promise<MLKitRecognizeTextCloudResult>;
+export declare function recognizeTextCloud(options: MLKitRecognizeTextCloudOptions): Promise<MLKitRecognizeTextResult>;
 
 export declare class MLKitTextRecognition extends MLKitCameraView {
 }
diff --git a/src/mlkit/textrecognition/index.ios.ts b/src/mlkit/textrecognition/index.ios.ts
diff --git a/src/scripts/postinstall.js b/src/scripts/postinstall.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { Component } from "@angular/core";`
`2`	`2`	`import {`
`3`		`- MLKitRecognizeTextOnDeviceResult,`
	`3`	`+ MLKitRecognizeTextResult,`
`4`	`4`	`MLKitRecognizeTextResultBlock`
`5`	`5`	`} from "nativescript-plugin-firebase/mlkit/textrecognition";`
`6`	`6`
`@@ -13,7 +13,7 @@ export class TextRecognitionComponent {`
`13`	`13`	`blocks: Array<MLKitRecognizeTextResultBlock>;`
`14`	`14`
`15`	`15`	`onTextRecognitionResult(scanResult: any): void {`
`16`		`- const value: MLKitRecognizeTextOnDeviceResult = scanResult.value;`
	`16`	`+ const value: MLKitRecognizeTextResult = scanResult.value;`
`17`	`17`	`this.blocks = value.blocks;`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -239,7 +239,7 @@ function echoAndroidManifestChanges(result) {`
`239`	`239`	`if (isSelected(result.ml_kit)) {`
`240`	`240`	`var selectedFeatures = [];`
`241`	`241`	`if (isSelected(result.ml_kit_text_recognition)) {`
`242`		`- selectedFeatures.push("text");`
	`242`	`+ selectedFeatures.push("ocr");`
`243`	`243`	`}`
`244`	`244`	`if (isSelected(result.ml_kit_barcode_scanning)) {`
`245`	`245`	`selectedFeatures.push("barcode");`