feat: add @valor/nativescript-in-app-review (#9)

mukaschultze · edusperoni · web-flow · commit 2fda8e898608 · 2022-12-15T16:43:16.000-03:00
* feat: add in-app review popup

* update com.google.android.play:core

* fix typo

* return promise

Co-authored-by: Eduardo Speroni &lt;edusperoni@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 - [@valor/nativescript-barcodescanner](packages/nativescript-barcodescanner/README.md)
 - [@valor/nativescript-feedback](packages/nativescript-feedback/README.md)
+- [@valor/nativescript-in-app-review](packages/nativescript-in-app-review/README.md)
 - [@valor/nativescript-ngrx-devtools](packages/nativescript-ngrx-devtools/README.md)
 - [@valor/nativescript-view-shot](packages/nativescript-view-shot/README.md)
 - [@valor/nativescript-websockets](packages/nativescript-websockets/README.md)
diff --git a/apps/demo-angular/package.json b/apps/demo-angular/package.json
@@ -6,7 +6,8 @@
     "@valor/nativescript-ngrx-devtools": "file:../../dist/packages/nativescript-ngrx-devtools",
     "@valor/nativescript-barcodescanner": "file:../../dist/packages/nativescript-barcodescanner",
     "@valor/nativescript-feedback": "file:../../dist/packages/nativescript-feedback",
-    "@valor/nativescript-view-shot": "file:../../dist/packages/nativescript-view-shot"
+    "@valor/nativescript-view-shot": "file:../../dist/packages/nativescript-view-shot",
+    "@valor/nativescript-in-app-review": "file:../../dist/packages/nativescript-in-app-review"
   },
   "devDependencies": {
     "@nativescript/android": "~8.3.0",
diff --git a/apps/demo-angular/src/app-routing.module.ts b/apps/demo-angular/src/app-routing.module.ts
@@ -9,6 +9,7 @@ const routes: Routes = [
   { path: 'home', component: HomeComponent },
   { path: 'nativescript-barcodescanner', loadChildren: () => import('./plugin-demos/nativescript-barcodescanner.module').then((m) => m.NativescriptBarcodescannerModule) },
   { path: 'nativescript-feedback', loadChildren: () => import('./plugin-demos/nativescript-feedback.module').then((m) => m.NativescriptFeedbackModule) },
+  { path: 'nativescript-in-app-review', loadChildren: () => import('./plugin-demos/nativescript-in-app-review.module').then((m) => m.NativescriptInAppReviewModule) },
   { path: 'nativescript-ngrx-devtools', loadChildren: () => import('./plugin-demos/nativescript-ngrx-devtools.module').then((m) => m.NativeScriptNgRxDevtoolsDemoModule) },
   { path: 'nativescript-view-shot', loadChildren: () => import('./plugin-demos/nativescript-view-shot.module').then((m) => m.NativescriptViewShotModule) },
   { path: 'nativescript-websockets', loadChildren: () => import('./plugin-demos/nativescript-websockets.module').then((m) => m.NativescriptWebsocketsModule) },
diff --git a/apps/demo-angular/src/home.component.ts b/apps/demo-angular/src/home.component.ts
@@ -12,6 +12,9 @@ export class HomeComponent {
     {
       name: 'nativescript-feedback',
     },
+    {
+      name: 'nativescript-in-app-review',
+    },
     {
       name: 'nativescript-ngrx-devtools',
     },
diff --git a/apps/demo-angular/src/plugin-demos/nativescript-in-app-review.component.html b/apps/demo-angular/src/plugin-demos/nativescript-in-app-review.component.html
@@ -0,0 +1,8 @@
+<ActionBar title="nativescript-in-app-review" class="action-bar"> </ActionBar>
+<StackLayout class="p-20">
+  <ScrollView class="h-full">
+    <StackLayout>
+      <Button text="Test nativescript-in-app-review" (tap)="demoShared.testIt()" class="btn btn-primary"></Button>
+    </StackLayout>
+  </ScrollView>
+</StackLayout>
diff --git a/apps/demo-angular/src/plugin-demos/nativescript-in-app-review.component.ts b/apps/demo-angular/src/plugin-demos/nativescript-in-app-review.component.ts
@@ -0,0 +1,17 @@
+import { Component, NgZone } from '@angular/core';
+import { DemoSharedNativescriptInAppReview } from '@demo/shared';
+import {} from '@valor/nativescript-in-app-review';
+
+@Component({
+  selector: 'demo-nativescript-in-app-review',
+  templateUrl: 'nativescript-in-app-review.component.html',
+})
+export class NativescriptInAppReviewComponent {
+  demoShared: DemoSharedNativescriptInAppReview;
+
+  constructor(private _ngZone: NgZone) {}
+
+  ngOnInit() {
+    this.demoShared = new DemoSharedNativescriptInAppReview();
+  }
+}
diff --git a/apps/demo-angular/src/plugin-demos/nativescript-in-app-review.module.ts b/apps/demo-angular/src/plugin-demos/nativescript-in-app-review.module.ts
@@ -0,0 +1,10 @@
+import { NgModule, NO_ERRORS_SCHEMA } from '@angular/core';
+import { NativeScriptCommonModule, NativeScriptRouterModule } from '@nativescript/angular';
+import { NativescriptInAppReviewComponent } from './nativescript-in-app-review.component';
+
+@NgModule({
+  imports: [NativeScriptCommonModule, NativeScriptRouterModule.forChild([{ path: '', component: NativescriptInAppReviewComponent }])],
+  declarations: [NativescriptInAppReviewComponent],
+  schemas: [NO_ERRORS_SCHEMA],
+})
+export class NativescriptInAppReviewModule {}
diff --git a/apps/demo/package.json b/apps/demo/package.json
@@ -8,7 +8,8 @@
     "@valor/nativescript-websockets": "file:../../packages/nativescript-websockets",
     "@valor/nativescript-barcodescanner": "file:../../packages/nativescript-barcodescanner",
     "@valor/nativescript-feedback": "file:../../packages/nativescript-feedback",
-    "@valor/nativescript-view-shot": "file:../../packages/nativescript-view-shot"
+    "@valor/nativescript-view-shot": "file:../../packages/nativescript-view-shot",
+    "@valor/nativescript-in-app-review": "file:../../packages/nativescript-in-app-review"
   },
   "devDependencies": {
     "@nativescript/android": "~8.3.0",
diff --git a/apps/demo/src/main-page.xml b/apps/demo/src/main-page.xml
@@ -9,6 +9,7 @@
         <Button text="nativescript-barcodescanner" tap="{{ viewDemo }}" class="btn btn-primary view-demo"/>
         <Button text="nativescript-feedback" tap="{{ viewDemo }}" class="btn btn-primary view-demo"/>
         <Button text="nativescript-view-shot" tap="{{ viewDemo }}" class="btn btn-primary view-demo"/>
+        <Button text="nativescript-in-app-review" tap="{{ viewDemo }}" class="btn btn-primary view-demo"/>
       </StackLayout>
     </ScrollView>
   </StackLayout>
diff --git a/apps/demo/src/plugin-demos/nativescript-in-app-review.ts b/apps/demo/src/plugin-demos/nativescript-in-app-review.ts
@@ -0,0 +1,10 @@
+import { Observable, EventData, Page } from '@nativescript/core';
+import { DemoSharedNativescriptInAppReview } from '@demo/shared';
+import {} from '@valor/nativescript-in-app-review';
+
+export function navigatingTo(args: EventData) {
+  const page = <Page>args.object;
+  page.bindingContext = new DemoModel();
+}
+
+export class DemoModel extends DemoSharedNativescriptInAppReview {}
diff --git a/apps/demo/src/plugin-demos/nativescript-in-app-review.xml b/apps/demo/src/plugin-demos/nativescript-in-app-review.xml
@@ -0,0 +1,14 @@
+<Page xmlns="http://schemas.nativescript.org/tns.xsd" navigatingTo="navigatingTo" class="page">
+    <Page.actionBar>
+        <ActionBar title="nativescript-in-app-review" icon="" class="action-bar">
+        </ActionBar>
+    </Page.actionBar>
+    <StackLayout class="p-20">
+        <ScrollView class="h-full">
+          <StackLayout>
+            <Button text="Test nativescript-in-app-review" tap="{{ testIt }}" class="btn btn-primary"/>
+
+          </StackLayout>
+        </ScrollView>
+    </StackLayout>
+</Page>
diff --git a/packages/nativescript-in-app-review/.eslintrc.json b/packages/nativescript-in-app-review/.eslintrc.json
@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*", "node_modules/**/*", "types/**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}
diff --git a/packages/nativescript-in-app-review/README.md b/packages/nativescript-in-app-review/README.md
@@ -0,0 +1,45 @@
+# @valor/nativescript-in-app-review
+
+<img src="https://user-images.githubusercontent.com/13923364/205458471-053fafcb-b16f-4661-95a9-ed71fac44d36.png" height="300px"/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+<img src="https://user-images.githubusercontent.com/13923364/205458594-44ca5d03-da9a-4fbc-a455-7775a8844c25.png" height="300px"/>
+
+```javascript
+ns plugin add @valor/nativescript-in-app-review
+```
+
+## Usage
+
+```ts
+import { InAppReview } from '@valor/nativescript-in-app-review';
+
+InAppReview.requestReviewPopup();
+```
+
+## Quotas and limitations
+
+Due to limitations on both Android and iOS, there are no guarantees that the user will be presented with the popup after
+invoking the `requestReviewPopup()` method. And there's no way of knowing if the user was prompted for a review or not,
+nor if they left a review. Because of that, it's not recommended to invoke the method upon an user action (like a button
+tap).
+
+### Android
+
+- **Production builds** have a quota of around 1 prompt per month;
+- **Development builds** will never show the popup;
+- **Internal testing builds** will always show the popup, however, there's a bug on the play store that requires its app
+  data to be cleaned up after a successful prompt. You can read more about the issue and the workaround
+  [here](https://stackoverflow.com/questions/70954925/in-app-review-opens-only-once-when-testing-for-the-same-account);
+
+You can read more about quotas and testing for Android [here](https://developer.android.com/guide/playcore/in-app-review/test).
+
+### iOS
+
+- **Production builds** have a quota of 3 prompts per year for each unique build number (i.e., bundle id).
+- **Development builds** will always show the popup.
+- **TestFlight builds** will never show the popup.
+
+You can read more about quotas and testing for iOS [here](https://developer.apple.com/documentation/storekit/requesting_app_store_reviews?language=objc).
+
+## License
+
+Apache License Version 2.0
diff --git a/packages/nativescript-in-app-review/common.ts b/packages/nativescript-in-app-review/common.ts
@@ -0,0 +1 @@
+export class InAppReviewCommon {}
diff --git a/packages/nativescript-in-app-review/index.android.ts b/packages/nativescript-in-app-review/index.android.ts
@@ -0,0 +1,41 @@
+import { Application, Utils } from '@nativescript/core';
+import { InAppReviewCommon } from './common';
+
+export class InAppReview extends InAppReviewCommon {
+  static requestReviewPopup() {
+    const context = Utils.android.getApplicationContext() as android.content.Context;
+    const manager = com.google.android.play.core.review.ReviewManagerFactory.create(context);
+    const request = manager.requestReviewFlow();
+
+    return new Promise<void>((resolve, reject) =>
+      request.addOnCompleteListener(
+        new com.google.android.play.core.tasks.OnCompleteListener({
+          onComplete: (task) => {
+            if (!task.isSuccessful()) {
+              reject(new Error(task.getException()?.getMessage()));
+              return;
+            }
+
+            const reviewInfo = task.getResult();
+            const flow = manager.launchReviewFlow(Application.android.foregroundActivity, reviewInfo);
+
+            flow.addOnCompleteListener(
+              new com.google.android.play.core.tasks.OnCompleteListener({
+                onComplete: (task) => {
+                  // The flow has finished. The API does not indicate whether the
+                  // user reviewed or not, or even whether the review dialog was
+                  // shown. Thus, no matter the result, we continue our app flow.
+                  if (!task.isSuccessful()) {
+                    reject(new Error(task.getException()?.getMessage()));
+                  } else {
+                    resolve();
+                  }
+                },
+              })
+            );
+          },
+        })
+      )
+    );
+  }
+}
diff --git a/packages/nativescript-in-app-review/index.d.ts b/packages/nativescript-in-app-review/index.d.ts
@@ -0,0 +1,9 @@
+import { InAppReviewCommon } from './common';
+
+export declare class InAppReview extends InAppReviewCommon {
+  /**
+   * Request the system to show a popup asking the user to leave an app review.
+   * Whether the popup will be shown or not depends on the system's heuristics.
+   */
+  static requestReviewPopup(): Promise<void>;
+}
diff --git a/packages/nativescript-in-app-review/index.ios.ts b/packages/nativescript-in-app-review/index.ios.ts
@@ -0,0 +1,14 @@
+import { Application, Device } from '@nativescript/core';
+import { InAppReviewCommon } from './common';
+
+export class InAppReview extends InAppReviewCommon {
+  static requestReviewPopup() {
+    if (+Device.sdkVersion < 14.0) {
+      SKStoreReviewController.requestReview();
+    } else {
+      SKStoreReviewController.requestReviewInScene((Application.ios.window as UIWindow).windowScene);
+    }
+
+    return Promise.resolve();
+  }
+}
diff --git a/packages/nativescript-in-app-review/package.json b/packages/nativescript-in-app-review/package.json
@@ -0,0 +1,35 @@
+{
+  "name": "@valor/nativescript-in-app-review",
+  "version": "1.0.0",
+  "description": "Native in-app review popups for NativeScript apps",
+  "main": "index",
+  "typings": "index.d.ts",
+  "nativescript": {
+    "platforms": {
+      "ios": "6.0.0",
+      "android": "6.0.0"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/valor-software/nativescript-plugins.git"
+  },
+  "keywords": [
+    "NativeScript",
+    "JavaScript",
+    "TypeScript",
+    "iOS",
+    "Android"
+  ],
+  "author": {
+    "name": "Samuel Schultze",
+    "email": "samuel.schultze@valor-software.com"
+  },
+  "bugs": {
+    "url": "https://github.com/valor-software/nativescript-plugins/issues"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/valor-software/nativescript-plugins",
+  "readmeFilename": "README.md",
+  "bootstrapper": "@nativescript/plugin-seed"
+}
diff --git a/packages/nativescript-in-app-review/platforms/android/include.gradle b/packages/nativescript-in-app-review/platforms/android/include.gradle
@@ -0,0 +1,3 @@
+dependencies {
+    implementation 'com.google.android.play:core:1.10.3'
+}
diff --git a/packages/nativescript-in-app-review/project.json b/packages/nativescript-in-app-review/project.json
@@ -0,0 +1,64 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "packages/nativescript-in-app-review",
+  "targets": {
+    "build": {
+      "executor": "@nrwl/js:tsc",
+      "options": {
+        "outputPath": "dist/packages/nativescript-in-app-review",
+        "tsConfig": "packages/nativescript-in-app-review/tsconfig.json",
+        "packageJson": "packages/nativescript-in-app-review/package.json",
+        "main": "packages/nativescript-in-app-review/index.d.ts",
+        "assets": [
+          "packages/nativescript-in-app-review/*.md",
+          "packages/nativescript-in-app-review/index.d.ts",
+          "LICENSE",
+          {
+            "glob": "**/*",
+            "input": "packages/nativescript-in-app-review/platforms/",
+            "output": "./platforms/"
+          }
+        ],
+        "dependsOn": [
+          {
+            "target": "build.all",
+            "projects": "dependencies"
+          }
+        ]
+      }
+    },
+    "build.all": {
+      "executor": "@nrwl/workspace:run-commands",
+      "options": {
+        "commands": ["node tools/scripts/build-finish.ts nativescript-in-app-review"],
+        "parallel": false
+      },
+      "outputs": ["dist/packages/nativescript-in-app-review"],
+      "dependsOn": [
+        {
+          "target": "build.all",
+          "projects": "dependencies"
+        },
+        {
+          "target": "build",
+          "projects": "self"
+        }
+      ]
+    },
+    "focus": {
+      "executor": "@nrwl/workspace:run-commands",
+      "options": {
+        "commands": ["nx g @nativescript/plugin-tools:focus-packages nativescript-in-app-review"],
+        "parallel": false
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "options": {
+        "lintFilePatterns": ["packages/nativescript-in-app-review/**/*.ts"]
+      }
+    }
+  },
+  "tags": []
+}
diff --git a/packages/nativescript-in-app-review/references.d.ts b/packages/nativescript-in-app-review/references.d.ts
@@ -0,0 +1,2 @@
+/// <reference path="../../references.d.ts" />
+/// <reference path="./types/play-core-android.d.ts" />
diff --git a/packages/nativescript-in-app-review/tsconfig.json b/packages/nativescript-in-app-review/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "rootDir": "."
+  },
+  "exclude": ["**/*.spec.ts", "**/*.test.ts", "angular"],
+  "include": ["**/*.ts", "references.d.ts"]
+}
diff --git a/packages/nativescript-in-app-review/types/play-core-android.d.ts b/packages/nativescript-in-app-review/types/play-core-android.d.ts
diff --git a/tools/demo/index.ts b/tools/demo/index.ts
diff --git a/tools/demo/nativescript-in-app-review/index.ts b/tools/demo/nativescript-in-app-review/index.ts
diff --git a/tools/workspace-scripts.js b/tools/workspace-scripts.js
diff --git a/tsconfig.base.json b/tsconfig.base.json
diff --git a/workspace.json b/workspace.json

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@ export class HomeComponent {`
`12`	`12`	`{`
`13`	`13`	`name: 'nativescript-feedback',`
`14`	`14`	`},`
	`15`	`+ {`
	`16`	`+ name: 'nativescript-in-app-review',`
	`17`	`+ },`
`15`	`18`	`{`
`16`	`19`	`name: 'nativescript-ngrx-devtools',`
`17`	`20`	`},`