Feature/help center collections

README.md

@@ -668,6 +668,35 @@ Open up your apps help center
 
 `Promise<boolean>`
 
+___
+### `Intercom.displayHelpCenterCollections()`
+
+Present the help center with specific collections only .
+
+###### Note: If the requested collections cannot be found, the full help center will be shown instead.
+### Options
+
+| Type    | Type        | Required |
+| ------- | --------    | -------- |
+| collections| string[]  |no        |
+
+### Returns
+
+`Promise<boolean>`
+
+___
+### `Intercom.displayArticle(articleId)`
+
+Displays article with given id.
+
+| Type    | Type        | Required |
+| ------- | --------    | -------- |
+| articleId| string  |yes        |
+
+### Returns
+
+`Promise<boolean>`
+
 ___
 
 ### `Intercom.displayCarousel(carouselId)`

android/build.gradle

@@ -1,3 +1,7 @@
+ def packageJsonFile = file('../package.json')
+ def packageJson = new groovy.json.JsonSlurper().parseText(packageJsonFile.text)
+
+
 buildscript {
     if (project == rootProject) {
         repositories {
@@ -24,7 +28,7 @@ android {
         minSdkVersion safeExtGet('IntercomReactNative_minSdkVersion', 21)
         targetSdkVersion safeExtGet('IntercomReactNative_targetSdkVersion', 29)
         versionCode 1
-        versionName "1.0"
+        versionName packageJson.version
 
     }
 
@@ -55,5 +59,5 @@ repositories {
 dependencies {
     //noinspection GradleDynamicVersion
     implementation "com.facebook.react:react-native:+"  // From node_modules
-    implementation 'io.intercom.android:intercom-sdk:9.+'
+    implementation 'io.intercom.android:intercom-sdk:10.+'
 }

android/src/main/java/com/intercom/reactnative/IntercomErrorCodes.java

@@ -14,10 +14,11 @@ public class IntercomErrorCodes {
   public static final String DISPLAY_CAROUSEL = "203";
   public static final String DISPLAY_HELP_CENTER = "204";
   public static final String SET_IN_APP_MESSAGE_VISIBILITY = "205";
-  public static final String HIDE_MESSENGER = "206";
+  public static final String HIDE_INTERCOM = "206";
   public static final String DISPLAY_ARTICLE = "207";
   public static final String SET_LAUNCHER_VISIBILITY = "208";
   public static final String SET_BOTTOM_PADDING = "209";
+  public static final String DISPLAY_HELP_CENTER_COLLECTIONS = "210";
   public static final String HANDLE_PUSH_MESSAGE = "301";
   public static final String SEND_TOKEN_TO_INTERCOM = "302";
 }

android/src/main/java/com/intercom/reactnative/IntercomHelpers.java

@@ -153,6 +153,19 @@ public static List<Object> recursivelyDeconstructReadableArray(ReadableArray rea
     return deconstructedList;
   }
 
+  public static List<String> readableArrayToStringList(ReadableArray readableArray) {
+    List<String> deconstructedList = new ArrayList<>();
+    for (int i = 0; i < readableArray.size(); i++) {
+      ReadableType indexType = readableArray.getType(i);
+      switch (indexType) {
+        case String:
+          deconstructedList.add(i, readableArray.getString(i));
+          break;
+      }
+    }
+    return deconstructedList;
+  }
+
   public static UserAttributes buildUserAttributes(ReadableMap readableMap) {
     UserAttributes.Builder builder = new UserAttributes.Builder();
     ReadableMapKeySetIterator iterator = readableMap.keySetIterator();

android/src/main/java/com/intercom/reactnative/IntercomModule.java

@@ -11,14 +11,17 @@
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.module.annotations.ReactModule;
 import com.google.firebase.messaging.RemoteMessage;
 
+import java.util.List;
 import java.util.Map;
 
 import io.intercom.android.sdk.Intercom;
 import io.intercom.android.sdk.UserAttributes;
+import io.intercom.android.sdk.api.ReactNativeHeaderInterceptor;
 import io.intercom.android.sdk.identity.Registration;
 import io.intercom.android.sdk.push.IntercomPushClient;
 
@@ -272,6 +275,20 @@ public void displayHelpCenter(Promise promise) {
     }
   }
 
+  @ReactMethod
+  public void displayHelpCenterCollections(ReadableArray collectionsId, Promise promise) {
+    try {
+      List<String> list = IntercomHelpers.readableArrayToStringList(collectionsId);
+      Intercom.client().displayHelpCenterCollections(list);
+      Log.d(NAME, "displayHelpCenterCollections");
+      promise.resolve(true);
+    } catch (Exception err) {
+      Log.e(NAME, "displayHelpCenterCollections error:");
+      Log.e(NAME, err.toString());
+      promise.reject(IntercomErrorCodes.DISPLAY_HELP_CENTER_COLLECTIONS, err.toString());
+    }
+  }
+
   @ReactMethod
   public void displayCarousel(String carouselId, Promise promise) {
     try {
@@ -284,6 +301,7 @@ public void displayCarousel(String carouselId, Promise promise) {
       promise.reject(IntercomErrorCodes.DISPLAY_CAROUSEL, err.toString());
     }
   }
+
   @ReactMethod
   public void displayArticle(String articleId, Promise promise) {
     try {
@@ -311,15 +329,15 @@ public void setInAppMessageVisibility(String visibility, Promise promise) {
   }
 
   @ReactMethod
-  public void hideMessenger(Promise promise) {
+  public void hideIntercom(Promise promise) {
     try {
-      Intercom.client().hideMessenger();
-      Log.d(NAME, "hideMessenger");
+      Intercom.client().hideIntercom();
+      Log.d(NAME, "hideIntercom");
       promise.resolve(true);
     } catch (Exception err) {
-      Log.e(NAME, "hideMessenger error:");
+      Log.e(NAME, "hideIntercom error:");
       Log.e(NAME, err.toString());
-      promise.reject(IntercomErrorCodes.HIDE_MESSENGER, err.toString());
+      promise.reject(IntercomErrorCodes.HIDE_INTERCOM, err.toString());
     }
   }
 
@@ -350,6 +368,8 @@ public void setBottomPadding(int paddingBottom, Promise promise) {
   }
 
   public static synchronized void initialize(Application application, String apiKey, String appId) {
+    String sdkVersion = BuildConfig.VERSION_NAME;
+    ReactNativeHeaderInterceptor.setReactNativeVersion(application.getApplicationContext(), sdkVersion);
     Intercom.initialize(application, apiKey, appId);
   }
 

android/src/main/java/io/intercom/android/sdk/api/ReactNativeHeaderInterceptor.java

@@ -0,0 +1,12 @@
+package io.intercom.android.sdk.api;
+
+import android.content.Context;
+import android.util.Log;
+
+public class ReactNativeHeaderInterceptor {
+  public static void setReactNativeVersion(Context context, String rnVersion) {
+    HeaderInterceptor.setReactNativeVersion(context, rnVersion);
+    Log.d("ReactNativeHeader", "Registered RN Header");
+    Log.d("ReactNativeHeader", rnVersion);
+  }
+}

example/e2e/helpers.ts

@@ -47,13 +47,28 @@ const closeOverlay = async () => {
 };
 browser.addCommand('closeOverlay', closeOverlay);
 
-const closeHelpCenterOverlay = async () => {
+const closeArticleOverlay = async () => {
   if (browser.isAndroid) {
-    await closeOverlay();
+    const closeButton = await $(
+      `/hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/android.view.ViewGroup/android.view.ViewGroup/android.view.ViewGroup/android.widget.ImageButton`
+    );
+    await closeButton.waitForDisplayed({ timeout: 22000 });
+    await closeButton.click();
   } else {
-    const closeButton = await $(`~intercom help center close button`);
+    await closeOverlay();
+  }
+};
+browser.addCommand('closeArticleOverlay', closeArticleOverlay);
+
+const closeHelpCenterOverlay = async () => {
+  if (browser.isAndroid) {
+    const closeButton = await $(
+      `/hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/android.view.ViewGroup/android.widget.FrameLayout/android.view.ViewGroup/android.view.ViewGroup/android.widget.ImageButton`
+    );
     await closeButton.waitForDisplayed({ timeout: 22000 });
     await closeButton.click();
+  } else {
+    await closeOverlay();
   }
 };
 browser.addCommand('closeHelpCenterOverlay', closeHelpCenterOverlay);

example/e2e/tests/example.e2e.ts → example/e2e/tests/mainIntercom.e2e.ts

@@ -20,7 +20,7 @@ describe('Intercom E2E', () => {
 
   it('Should display article', async () => {
     await (await $('~display-article')).click();
-    await driver.closeOverlay();
+    await driver.closeArticleOverlay();
   });
 
   it('Should message composer', async () => {
@@ -37,6 +37,14 @@ describe('Intercom E2E', () => {
     await driver.closeHelpCenterOverlay();
   });
 
+  it('Should display help center collections', async () => {
+    await driver.scrollToElementByAccessibilityLabel(
+      'display-help-center-collections'
+    );
+    await (await $('~display-help-center-collections')).click();
+    await driver.closeHelpCenterOverlay();
+  });
+
   it('Should display carousel', async () => {
     await driver.scrollToElementByAccessibilityLabel('display-carousel');
     await (await $('~display-carousel')).click();
@@ -63,10 +71,10 @@ describe('Intercom E2E', () => {
     );
     await driver.clickWithDelay('~toggle-launcher-visibility', 12000);
 
-    const laincherId = driver.isAndroid
+    const launcherId = driver.isAndroid
       ? '~Intercom launcher'
       : '~intercom launcher';
-    await (await $(laincherId)).waitForDisplayed({ timeout: 12000 });
+    await (await $(launcherId)).waitForDisplayed({ timeout: 12000 });
     await driver.clickWithDelay('~toggle-launcher-visibility', 12000);
   });
 

example/e2e/types/wido.d.ts

@@ -7,6 +7,7 @@ declare global {
       wait: (milis: number) => Promise<void>;
       clickWithDelay: (element: string, milis: number) => Promise<void>;
       closeHelpCenterOverlay: () => Promise<void>;
+      closeArticleOverlay: () => Promise<void>;
       closeOverlay: () => Promise<void>;
       closeAlert: () => Promise<void>;
     }

example/ios/IntercomReactNativeExample.xcodeproj/project.pbxproj

@@ -533,10 +533,12 @@
 			inputPaths = (
 				"${PODS_ROOT}/Target Support Files/Pods-IntercomReactNativeExampleUI/Pods-IntercomReactNativeExampleUI-resources.sh",
 				"${PODS_CONFIGURATION_BUILD_DIR}/React-Core/AccessibilityResources.bundle",
+				"${PODS_CONFIGURATION_BUILD_DIR}/intercom-react-native/IntercomFramework.bundle",
 			);
 			name = "[CP] Copy Pods Resources";
 			outputPaths = (
 				"${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/AccessibilityResources.bundle",
+				"${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/IntercomFramework.bundle",
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
@@ -551,10 +553,12 @@
 			inputPaths = (
 				"${PODS_ROOT}/Target Support Files/Pods-IntercomReactNativeExample/Pods-IntercomReactNativeExample-resources.sh",
 				"${PODS_CONFIGURATION_BUILD_DIR}/React-Core/AccessibilityResources.bundle",
+				"${PODS_CONFIGURATION_BUILD_DIR}/intercom-react-native/IntercomFramework.bundle",
 			);
 			name = "[CP] Copy Pods Resources";
 			outputPaths = (
 				"${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/AccessibilityResources.bundle",
+				"${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/IntercomFramework.bundle",
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;

example/ios/Podfile.lock

@@ -77,9 +77,9 @@ PODS:
     - DoubleConversion
     - glog
   - glog (0.3.5)
-  - Intercom (9.3.6)
+  - Intercom (10.0.1)
   - intercom-react-native (0.1.0):
-    - Intercom (~> 9.3.6)
+    - Intercom (~> 10.0)
     - React-Core
   - libevent (2.1.12)
   - OpenSSL-Universal (1.1.180)
@@ -457,8 +457,8 @@ SPEC CHECKSUMS:
   FlipperKit: 651f50a42eb95c01b3e89a60996dd6aded529eeb
   Folly: b73c3869541e86821df3c387eb0af5f65addfab4
   glog: 40a13f7840415b9a77023fbcae0f1e6f43192af3
-  Intercom: d44bd4264f61a3e343cac46d7b88d4db0f860077
-  intercom-react-native: ffdf95e08035567701665c258fa9b67bb508aa8a
+  Intercom: 9512379fa2a4aaf84cd8884f23b932002edb3147
+  intercom-react-native: 41bba370e914eaa8ae2f2a84eb312e580c27460d
   libevent: 4049cae6c81cdb3654a443be001fb9bdceff7913
   OpenSSL-Universal: 1aa4f6a6ee7256b83db99ec1ccdaa80d10f9af9b
   RCTRequired: 082f10cd3f905d6c124597fd1c14f6f2655ff65e
@@ -485,6 +485,6 @@ SPEC CHECKSUMS:
   Yoga: 4bd86afe9883422a7c4028c00e34790f560923d6
   YogaKit: f782866e155069a2cca2517aafea43200b01fd5a
 
-PODFILE CHECKSUM: f137f43a8864eea77c51e3f09b5ae3cf758392a4
+PODFILE CHECKSUM: 242765731e522625435b8c46a95480e6552fe3d6
 
 COCOAPODS: 1.10.1

example/src/App.tsx

@@ -17,12 +17,12 @@ import Button from './Button';
 import type { Registration } from '../../lib/typescript';
 import Config from 'react-native-config';
 
+const COLLECTIONS: string[] = []; //Provide help center collections ids
 // To change, replace values in .env
 const CAROUSEL_ID = Config.CAROUSEL_ID;
 const EVENT_NAME = Config.EVENT_NAME;
 const ARTICLE_ID = Config.ARTICLE_ID;
 const USER_NAME = Config.USER_NAME;
-
 const TOKEN = Platform.select({
   ios: 'RN-IOS-TOKEN',
   default: 'RN-ANDROID-TOKEN',
@@ -185,10 +185,18 @@ export default function App() {
             Intercom.displayHelpCenter();
           }}
         />
+        <Button
+          accessibilityLabel="display-help-center-collections"
+          disabled={!loggedUser}
+          title={'Display Help Center Collections'}
+          onPress={() => {
+            Intercom.displayHelpCenterCollections(COLLECTIONS);
+          }}
+        />
         <Button
           accessibilityLabel="display-carousel"
           disabled={!loggedUser}
-          title="Display Carousel"
+          title={'Display Carousel'}
           onPress={() => {
             console.log(CAROUSEL_ID);
             Intercom.displayCarousel(CAROUSEL_ID);