Merge pull request #15 from intercom/feature/help-center-fetch-methods

Feature/help center fetch methods

Author: pi0trpietruszewski

README.md

@@ -23,6 +23,7 @@
     - [Push Notifications](#ios-push-notifications)
     - [Push notification deep links support](#ios-push-notification-deep-links-support)
 - [Common methods](#methods)
+  - [Types](#types)
 - [Usage](#usage)
 - [Troubleshooting](#troubleshooting)
 - [Author](#author)
@@ -684,6 +685,46 @@ Present the help center with specific collections only .
 
 `Promise<boolean>`
 
+___
+### `Intercom.fetchHelpCenterCollections()`
+
+Fetch a list of all Collections.
+
+
+### Returns
+`Promise<HelpCenterCollectionItem[]>`
+
+
+___
+### `Intercom.fetchHelpCenterCollection(collectionId)`
+
+Get a list of sections/articles for a collection.
+
+### Options
+
+| Type    | Type        | Required |
+| ------- | --------    | -------- |
+| collectionId| string  |yes        |
+
+### Returns
+
+`Promise<HelpCenterCollectionContent>`
+
+___
+### `Intercom.searchHelpCenter(searchTerm)`
+
+Get a list of articles in the Help Center, filtered by a search term
+
+### Options
+
+| Type    | Type        | Required |
+| ------- | --------    | -------- |
+| searchTerm| string  |yes        |
+
+### Returns
+
+`Promise<HelpCenterArticleSearchResult[]>`
+
 ___
 ### `Intercom.displayArticle(articleId)`
 
@@ -827,6 +868,41 @@ useEffect(() => {
 
 `EmitterSubscription`
 
+___
+### Types
+
+```typescript
+type HelpCenterArticle = {
+  it: string;
+  title: string;
+};
+
+type HelpCenterSection = {
+  name: string;
+  articles: HelpCenterArticle;
+};
+
+type HelpCenterCollectionItem = {
+  id: string;
+  title: string;
+  summary: string;
+};
+
+type HelpCenterCollectionContent = {
+  id: string;
+  name: string;
+  summary: string;
+  articles: HelpCenterArticle[];
+  sections: HelpCenterSection[];
+};
+
+type HelpCenterArticleSearchResult = {
+  id: string;
+  title: string;
+  matchingSnippet: string;
+  summary: string;
+};
+```
 ___
 
 ## Usage

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

@@ -332,7 +332,7 @@ public void onFailure() {
   @ReactMethod
   public void fetchHelpCenterCollection(String collectionId, Promise promise) {
     try {
-      if (collectionId.equals("") ) {
+      if (collectionId.equals("")) {
         promise.reject(IntercomErrorCodes.FETCH_HELP_CENTER_COLLECTION, "collectionID can\'t be empty");
       } else {
         CollectionContentRequestCallback collectionContentCallback = new CollectionContentRequestCallback() {
@@ -366,33 +366,36 @@ public void onFailure() {
 
   @ReactMethod
   public void searchHelpCenter(String searchTerm, Promise promise) {
-    try {
-
-      SearchRequestCallback collectionContentCallback = new SearchRequestCallback() {
-        @Override
-        public void onComplete(@NotNull List<HelpCenterArticleSearchResult> helpCenterArticleSearchResult) {
-          promise.resolve(IntercomHelpCenterHelpers.parseHelpCenterArticleSearchToReadableArray(helpCenterArticleSearchResult));
-        }
+    if (searchTerm.equals("")) {
+      promise.reject(IntercomErrorCodes.SEARCH_HELP_CENTER, "searchTerm can\'t be empty");
+    } else {
+      try {
+        SearchRequestCallback collectionContentCallback = new SearchRequestCallback() {
+          @Override
+          public void onComplete(@NotNull List<HelpCenterArticleSearchResult> helpCenterArticleSearchResult) {
+            promise.resolve(IntercomHelpCenterHelpers.parseHelpCenterArticleSearchToReadableArray(helpCenterArticleSearchResult));
+          }
 
-        @Override
-        public void onError(int i) {
-          Log.e(NAME, "searchHelpCenter error");
-          promise.reject(String.valueOf(i), "searchHelpCenter error");
-        }
+          @Override
+          public void onError(int i) {
+            Log.e(NAME, "searchHelpCenter error");
+            promise.reject(String.valueOf(i), "searchHelpCenter error");
+          }
 
-        @Override
-        public void onFailure() {
-          Log.e(NAME, "searchHelpCenter failure");
-          promise.reject(IntercomErrorCodes.SEARCH_HELP_CENTER, "searchHelpCenter failure");
-        }
-      };
-      Log.d(NAME, "searchHelpCenter");
-      Intercom.client().searchHelpCenter(searchTerm, collectionContentCallback);
+          @Override
+          public void onFailure() {
+            Log.e(NAME, "searchHelpCenter failure");
+            promise.reject(IntercomErrorCodes.SEARCH_HELP_CENTER, "searchHelpCenter failure");
+          }
+        };
+        Log.d(NAME, "searchHelpCenter");
+        Intercom.client().searchHelpCenter(searchTerm, collectionContentCallback);
 
-    } catch (Exception err) {
-      Log.e(NAME, "searchHelpCenter error:");
-      Log.e(NAME, err.toString());
-      promise.reject(IntercomErrorCodes.SEARCH_HELP_CENTER, err.toString());
+      } catch (Exception err) {
+        Log.e(NAME, "searchHelpCenter error:");
+        Log.e(NAME, err.toString());
+        promise.reject(IntercomErrorCodes.SEARCH_HELP_CENTER, err.toString());
+      }
     }
   }
 

example/.env.example

@@ -6,5 +6,5 @@ CAROUSEL_ID=$CAROUSEL_ID
 EVENT_NAME=$EVENT_NAME
 ARTICLE_ID=$ARTICLE_ID
 USER_NAME=$USER_NAME
-SECTION_ID=$SECTION_ID
+COLLECTION_ID=$COLLECTION_ID
 SEARCH_TERM=$SEARCH_TERM

example/ios/IntercomReactNativeExample/Info.plist

@@ -2,8 +2,6 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-	<key>NSPhotoLibraryUsageDescription</key>
-	<string>Send photos to support center</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleDisplayName</key>
@@ -37,6 +35,10 @@
 	</array>
 	<key>CFBundleVersion</key>
 	<string>1</string>
+	<key>IntercomUniversalLinkDomains</key>
+	<array>
+		<string>intercom.com</string>
+	</array>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>NSAppTransportSecurity</key>
@@ -54,6 +56,8 @@
 	</dict>
 	<key>NSLocationWhenInUseUsageDescription</key>
 	<string></string>
+	<key>NSPhotoLibraryUsageDescription</key>
+	<string>Send photos to support center</string>
 	<key>UIBackgroundModes</key>
 	<array>
 		<string>remote-notification</string>

example/scripts/generateEnv.sh

@@ -9,4 +9,4 @@ echo EVENT_NAME=$EVENT_NAME >>.env
 echo ARTICLE_ID=$ARTICLE_ID >>.env
 echo USER_NAME=$USER_NAME >>.env
 echo SEARCH_TERM=$SEARCH_TERM >>.env
-echo SECTION_ID=$SECTION_ID >>.env
+echo COLLECTION_ID=$COLLECTION_ID >>.env

ios/Intercom.xcodeproj/project.pbxproj

@@ -10,6 +10,7 @@
 		3A6572C897F85E4E8295FC2D /* IntercomEventEmitter.m in Sources */ = {isa = PBXBuildFile; fileRef = 3A657CFB9FBFC5F094B4D20D /* IntercomEventEmitter.m */; };
 		3A6576B390F8276AE2651D35 /* IntercomAttributesBuilder.m in Sources */ = {isa = PBXBuildFile; fileRef = 3A6576960DB107666B27C442 /* IntercomAttributesBuilder.m */; };
 		7D72E2FD26611EAB00A3C250 /* IntercomModule.m in Sources */ = {isa = PBXBuildFile; fileRef = B3E7B5891CC2AC0600A0062D /* IntercomModule.m */; };
+		7DAD57C02683B5B5001B040A /* IntercomHelpCenterHelpers.m in Sources */ = {isa = PBXBuildFile; fileRef = 7DAD57BF2683B5B5001B040A /* IntercomHelpCenterHelpers.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXCopyFilesBuildPhase section */
@@ -30,6 +31,8 @@
 		3A65761B82D336291D470582 /* IntercomEventEmitter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IntercomEventEmitter.h; sourceTree = "<group>"; };
 		3A6576960DB107666B27C442 /* IntercomAttributesBuilder.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IntercomAttributesBuilder.m; sourceTree = "<group>"; };
 		3A657CFB9FBFC5F094B4D20D /* IntercomEventEmitter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IntercomEventEmitter.m; sourceTree = "<group>"; };
+		7DAD57BF2683B5B5001B040A /* IntercomHelpCenterHelpers.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = IntercomHelpCenterHelpers.m; sourceTree = "<group>"; };
+		7DAD57C22683B5F0001B040A /* IntercomHelpCenterHelpers.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = IntercomHelpCenterHelpers.h; sourceTree = "<group>"; };
 		B3E7B5881CC2AC0600A0062D /* IntercomModule.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IntercomModule.h; sourceTree = "<group>"; };
 		B3E7B5891CC2AC0600A0062D /* IntercomModule.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IntercomModule.m; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -56,6 +59,8 @@
 		58B511D21A9E6C8500147676 = {
 			isa = PBXGroup;
 			children = (
+				7DAD57BF2683B5B5001B040A /* IntercomHelpCenterHelpers.m */,
+				7DAD57C22683B5F0001B040A /* IntercomHelpCenterHelpers.h */,
 				7D92790D26829806009550EB /* assets */,
 				B3E7B5881CC2AC0600A0062D /* IntercomModule.h */,
 				B3E7B5891CC2AC0600A0062D /* IntercomModule.m */,
@@ -131,6 +136,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				7DAD57C02683B5B5001B040A /* IntercomHelpCenterHelpers.m in Sources */,
 				7D72E2FD26611EAB00A3C250 /* IntercomModule.m in Sources */,
 				3A6576B390F8276AE2651D35 /* IntercomAttributesBuilder.m in Sources */,
 				3A6572C897F85E4E8295FC2D /* IntercomEventEmitter.m in Sources */,

ios/IntercomAttributesBuilder.h

@@ -1,8 +1,6 @@
 #import <Foundation/Foundation.h>
-
-@class ICMUserAttributes;
-
+#import <Intercom/Intercom.h>
 
 @interface IntercomAttributesBuilder : NSObject
 + (ICMUserAttributes *)userAttributesForDictionary:(NSDictionary *)attributesDict;
-@end
+@end

ios/IntercomHelpCenterHelpers.h

@@ -0,0 +1,11 @@
+#import <Foundation/Foundation.h>
+#import <Intercom/Intercom.h>
+
+@interface IntercomHelpCenterHelpers : NSObject
++ (NSMutableArray<NSMutableDictionary *> *)parseCollectionsToArray:(NSArray<ICMHelpCenterCollection *> *)collections;
++ (NSMutableArray<NSMutableDictionary *> *)parseArticlesToArray:(NSArray<ICMHelpCenterArticle *> *)articlesArray;
++ (NSMutableDictionary *)parseHelpCenterCollectionToDictionary:(ICMHelpCenterCollectionContent *)collectionContent;
++ (NSMutableArray<NSMutableDictionary *> *)parseHelpCenterSectionsToDictionary:(NSArray<ICMHelpCenterSection *> *)sectionArray;
++ (NSMutableArray<NSMutableDictionary *> *)parseHelpCenterArticleSearchResultToArray:(NSArray<ICMHelpCenterArticleSearchResult *>*)articleArray;
+
+@end

ios/IntercomHelpCenterHelpers.m

@@ -0,0 +1,74 @@
+#import "IntercomHelpCenterHelpers.h"
+#import <Intercom/Intercom.h>
+
+@implementation IntercomHelpCenterHelpers
+
++ (NSMutableArray<NSMutableDictionary *> *)parseCollectionsToArray:(NSArray<ICMHelpCenterCollection *> *)collections {
+    NSMutableArray<NSMutableDictionary *> *parsedCollections = [NSMutableArray arrayWithCapacity:[collections count]];
+
+    for (ICMHelpCenterCollection *collectionObject in collections) {
+        NSMutableDictionary *item = [NSMutableDictionary dictionary];
+        [item setValue:[collectionObject collectionId] forKey:@"id"];
+        [item setValue:[collectionObject title] forKey:@"title"];
+        [item setValue:[collectionObject summary] forKey:@"summary"];
+        [parsedCollections addObject:item];
+    }
+    return parsedCollections;
+}
+
++ (NSMutableArray<NSMutableDictionary *> *)parseArticlesToArray:(NSArray<ICMHelpCenterArticle *> *)articlesArray {
+
+    NSMutableArray *parsedArticles = [NSMutableArray arrayWithCapacity:[articlesArray count]];
+    for (ICMHelpCenterArticle *articleObject in articlesArray) {
+        NSMutableDictionary *articleItem = [NSMutableDictionary dictionary];
+        [articleItem setValue:[articleObject articleId] forKey:@"id"];
+        [articleItem setValue:[articleObject title] forKey:@"title"];
+        [parsedArticles addObject:articleItem];
+    }
+
+    return parsedArticles;
+}
+
++ (NSMutableDictionary *)parseHelpCenterCollectionToDictionary:(ICMHelpCenterCollectionContent *)collectionContent {
+
+    NSMutableDictionary *item = [NSMutableDictionary dictionary];
+    [item setValue:[collectionContent collectionId] forKey:@"id"];
+    [item setValue:[collectionContent title] forKey:@"title"];
+    [item setValue:[collectionContent summary] forKey:@"summary"];
+    [item setValue:[self parseArticlesToArray:[collectionContent articles]] forKey:@"articles"];
+    [item setValue:[self parseHelpCenterSectionsToDictionary:[collectionContent sections]] forKey:@"sections"];
+
+    return item;
+}
+
++ (NSMutableArray<NSMutableDictionary *> *)parseHelpCenterSectionsToDictionary:(NSArray<ICMHelpCenterSection *> *)sectionArray {
+
+    NSMutableArray *parsedSections = [NSMutableArray arrayWithCapacity:[sectionArray count]];
+    for (ICMHelpCenterSection *sectionObject in sectionArray) {
+        NSMutableDictionary *sectionItem = [NSMutableDictionary dictionary];
+        [sectionItem setValue:[sectionObject title] forKey:@"title"];
+        [sectionItem setValue:[self parseArticlesToArray:[sectionObject articles]] forKey:@"articles"];
+        [parsedSections addObject:sectionItem];
+    }
+
+    return parsedSections;
+}
+
++ (NSMutableArray<NSMutableDictionary *> *)parseHelpCenterArticleSearchResultToArray:(NSArray<ICMHelpCenterArticleSearchResult *>*)articleArray {
+
+    NSMutableArray *parsedArticles = [NSMutableArray arrayWithCapacity:[articleArray count]];
+    for (ICMHelpCenterArticleSearchResult *articleObject in articleArray) {
+        NSMutableDictionary *articleItem = [NSMutableDictionary dictionary];
+        [articleItem setValue:[articleObject title] forKey:@"title"];
+        [articleItem setValue:[articleObject articleId] forKey:@"id"];
+        [articleItem setValue:[articleObject matchingSnippet] forKey:@"matchingSnippet"];
+        [articleItem setValue:[articleObject summary] forKey:@"summary"];
+        [parsedArticles addObject:articleItem];
+    }
+
+    return parsedArticles;
+}
+
+
+@end
+

ios/IntercomModule.h

@@ -5,6 +5,6 @@
 + (void)setDeviceToken:(nonnull NSString *)deviceToken;
 + (BOOL)isIntercomPushNotification:(nonnull NSDictionary *)userInfo;
 + (void)handleIntercomPushNotification:(nonnull NSDictionary *)userInfo;
-+ (NSError *)exceptionToError:(NSException *)exception :(NSString *)code;
+- (NSError *)exceptionToError:(NSException *)exception :(NSString *)code :(NSString *)domain;
 
 @end