@originallyus/feedback-rn-sdk 1.0.7 → 2.0.0

package/README.md

@@ -4,11 +4,16 @@ A cross-platform Feedback component for React Native.
 
 ## Installation
 
-Add package:
+Install the package using either Yarn:
 
 ```sh
 yarn add @originallyus/feedback-rn-sdk
 ```
+or npm:
+
+```sh
+npm install @originallyus/feedback-rn-sdk
+```
 
 ## Install Peer Dependencies
 
@@ -21,15 +26,20 @@ react-native-device-info \
 react-native-rate
 ```
 
+or using npm:
+
+```sh
+npm install axios crypto-js \
+react-native-encrypted-storage \
+react-native-device-info \
+react-native-rate
+```
+
 ## Install Custom Fonts
 
 Package requires custom fonts found in `fonts` folder:
 
 ```sh
-AIAEverestBold.ttf
-AIAEverest-Regular.ttf
-AIAEverest-Medium.ttf
-AIAEverest-CondensedMedium.ttf
 OpenSans-Bold.ttf
 OpenSans-Light.ttf
 OpenSans-Regular.ttf
@@ -44,8 +54,11 @@ Please do not change the filenames as Android are using those to identify fonts.
 
 Please initalize the SDK once in App.js. The mounting point of the SDK should be placed directly in your App.js for it to stay on top of all other views.
 
+Note: **XXXXXXXXXXX** is to be replaced with correct class name. Please refer to the full documentation provided separately by us.
+
+
 ```js
-import AIAFeedback from '@originallyus/feedback-rn-sdk';
+import XXXXXXXXXXX from '@originallyus/feedback-rn-sdk';
 
 const App = (props) => {
   // This initialization should done once inside App.js
@@ -54,21 +67,39 @@ const App = (props) => {
 
 // in your render function
 return (
-  // Make sure the app is full screen and vertical align center
+  {/* The root view wrapper makes sure the app is full screen and vertical align center */}
   <View style={{ flex: 1, justifyContent: 'center' }}>
-    <YourOtherContainerView></YourOtherContainerView>
+    <YourAppContainerView></YourAppContainerView>
 
     {/* Please insert this mount point directly in your App.js,
         preferably at the bottom of your root view tree for it to stay on top of all other views */}
-    <AIAFeedback ref={feedbackRef} />
+    <XXXXXXXXXXX ref={feedbackRef} />
   </View>
 );
 ```
+**Optional inline feedback component**
+
+Place `<FeedbackInlineSurvey />` component anywhere in your app view hierarchy where the feedback inline prompt should be shown.
+
+- If `<FeedbackInlineSurvey />` component is not present, feedback survey will shown as non-intrusive style
+- The inline component may or may not be shown depends on configuration of the survey in backend
+
+```js
+import { FeedbackInlineSurvey } from '@originallyus/feedback-rn-sdk';
+
+return (
+  ...
+  <SomeContainerView>
+    <FeedbackInlineSurvey />
+  </SomeContainerView>
+  ...
+);
+```
 
 All other functions to be invoked on feedbackRef.current can be done anywhere in your application code (can also be inside App.js)
 
 ```js
-import AIAFeedback from '@originallyus/feedback-rn-sdk';
+import XXXXXXXXXXX from '@originallyus/feedback-rn-sdk';
 
 const OtherComponent = (props) => {
   // This is a singleton. The initialization should have already been done inside App.js
@@ -102,11 +133,24 @@ const OtherComponent = (props) => {
     feedbackRef.current.testRatingForm(eventTag);
   };
 
+  const testInlineForm = (eventTag, slug) => {
+    // This will always show the inline Feedback component for testing/debugging purpose
+    // You may troubleshoot this in "Request (Testing)" section in CMS
+    feedbackRef.current.testInlineForm(eventTag, slug);
+  };
+
   const showRatingForm = (eventTag) => {
     // This may not always show/trigger the form, depending on the Response Frequency & Prompt Frequency configuration on backend
     // You may troubleshoot this in "Request" section in CMS
     feedbackRef.current.showRatingForm(eventTag);
   };
+
+  const showInlineForm = (eventTag, slug) => {
+    // This may not always show/trigger the form, depending on the Response Frequency & Prompt Frequency configuration on backend
+    // You may troubleshoot this in "Request" section in CMS
+    feedbackRef.current.showInlineForm(eventTag, slug);
+  };
+  
 };
 ```
 
@@ -125,4 +169,27 @@ feedbackRef.current.testRatingForm(eventTag, (formDidShow) => {
 feedbackRef.current.showRatingForm(eventTag, (formDidShow) => {
   console.log('formDidShow', formDidShow);
 });
+
+feedbackRef.current.showInlineForm(eventTag, slug, (formDidShow) => {
+  console.log('formDidShow', formDidShow);
+});
+
+```
+
+## Extra configuration
+To ensure that the External Survey works properly, check your AndroidManifest.xml file for the following configuration.
+
+```
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example">
+    <queries>
+        <intent>
+            <action android:name="android.intent.action.VIEW" />
+            <data android:scheme="http" />
+            <data android:scheme="https" />
+        </intent>
+    </queries>
+    ...
+    <!-- Another config -->
+</manifest>
+
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@originallyus/feedback-rn-sdk",
-  "version": "1.0.7",
+  "version": "2.0.0",
   "description": "A cross-platform Feedback component for React Native.",
   "main": "lib/commonjs/index",
   "react-native": "lib/commonjs/index",
@@ -15,6 +15,7 @@
     "email": "hello@originallyus.us"
   },
   "devDependencies": {
+    "@babel/runtime": "^7.24.0",
     "babel-preset-react-native": "^4.0.0",
     "react": "^16.2.0",
     "react-native": "^0.53.0"
@@ -30,5 +31,6 @@
   },
   "dependencies": {
     "react-native-android-keyboard-adjust-originallyus": "*"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
 }