@moxtradeveloper/react-native-moxo-module 8.9.5 → 8.12.2

package/LICENSE

@@ -1,6 +1,21 @@
 MIT License
 
-Copyright (c) 2022 john.hu
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+Copyright (c) 2023 Moxo
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,17 +1,43 @@
-# react-native-moxo-module
-reactnative-moxo-module is based on native Moxo MEPSDK, for now it only provides ability to call native SDK functions.
+![moxo](https://assets-global.website-files.com/612ecbcc615e87b0b9b38524/62037243f5ede375a8705a34_Moxo-Website-Button.svg)
+
+[ [Introduce](#introduce) • [Preparation](#preparation) • [Installation](#installation) • [Initialization](#initialization) • [Sample Code](#sample-code) • [API Doc](#api-doc)]
+
+## Introduce
+
+**react-native-moxo-module** is a [moxo sdk](https://www.moxo.com/platform/sdks) react-native wrapper. Provide Moxo OneStop capabilities to your mobile app built on [React Native](https://reactnative.dev/)
+
+### Supported Platforms
+
+* iOS 13.0+
+* Android 4.4+
+
+## Preparation
+
+Below sdk or tools are required before start to use react-native-moxo-module.
+
+* Node.js v14+
+* Watchman
+
+### Android
+
+* Android Studio
+* Android SDK v19+
+
+### iOS
+
+* Xcode v14.1+
+* Cocoapod v1.11.0+
+
+For more react-native set up details, please ref to [react native official site](https://reactnative.dev/docs/environment-setup)
 
 ## Installation
 
 ```sh
-npm install react-native-moxo-module
+npm install @moxtradeveloper/react-native-moxo-module
 ```
-#### Supported platforms
-iOS: iOS 13, Xcode 14
-
-Android: 
 
 ### iOS Specific Steps
+
 * Add moxo cocoapod repo as source into Podfile under your iOS project.
 * Change pod deployment platform to iOS 13
 
@@ -30,13 +56,13 @@ install! 'cocoapods', :deterministic_uuids => false
 # Rest of the file.....
 ```
 
-## Quick start 
-```js
-import * as moxo from 'react-native-moxo-module';
+## Initialization
 
-// Setup domain
-moxo.setup('myenv.moxo.com')
+### Login
+
+Before login, we need to get access token, by Moxo RestAPI:
 
+```js
 // Get access token
 const response = await fetch('https://myenv.moxo.com/v1/core/oauth/token', {
     method: 'POST',
@@ -53,22 +79,50 @@ const response = await fetch('https://myenv.moxo.com/v1/core/oauth/token', {
 })
 const json = await response.json();
 token = json.access_token
+```
 
+Import plugin before use, then initialize moxo sdk and login with access token:
+
+```js
+import * as moxo from 'react-native-moxo-module';
+// Setup domain
+moxo.setup('myenv.moxo.com')
 //Login and show moxo engagement platform window
-moxo.link(token).then((success)=>{
+moxo.link(token).then((result)=>{
 if (result)
-    moxo.showMEPWindow();
+    console.log(`Link success`)
 }).catch((err=>{
     console.log(`Link failed!:${err}`);
 }))
 ```
+
+### Show MEP window
+
+After login successful, we can show MEP window directly.
+
+```js
+moxo.showMEPWindow();
+```
+
+## Sample Code
+
+### Open existing chat
+
+If user is logged in, call open chat API to open existing chat. If not logged in or chat does not exists, API will return error with error code and error message.
+
+```js
+moxo.openChat('CBSmiUUjyIJP7gR8YIpiagvH', '')
+```
+
 ### Notification
+
 To enable notification feature, you'll need to integrate a notification module first, here we take [react-native-notifications](https://www.npmjs.com/package/react-native-notifications) for example, which can help to get device token and notification payload.
 
 #### Register notification
-Through react-native-notifications registerRemoteNotifications(), post user agreement, notification will be enabled for your app. 
+
+Through react-native-notifications registerRemoteNotifications(), post user agreement, notification will be enabled for your app.
 Call registerRemoteNotificationsRegistered() to get a device token.
-Then pass token to moxo function ```registerNotification()``` will register notification to Moxo server.
+Then pass token to moxo function ``registerNotification()`` will register notification to Moxo server.
 
 ```js
     Notifications.registerRemoteNotifications();
@@ -84,7 +138,8 @@ Then pass token to moxo function ```registerNotification()``` will register noti
 ```
 
 #### Handle notification
-For example, once notification received, and user tapped notification, react-native-notifications function registerNotificationOpened will be triggered with notification payload data. Then pass payload to moxo function ```parseNotification()``` like below:
+
+For example, once notification received, and user tapped notification, react-native-notifications function registerNotificationOpened will be triggered with notification payload data. Then pass payload to moxo function ``parseNotification()`` like below:
 
 ```js
     Notifications.events().registerNotificationOpened((notification: Notification, completion: () => void, action?: NotificationActionResponse) => {
@@ -101,10 +156,10 @@ For example, once notification received, and user tapped notification, react-nat
     });
 ```
 
-If is a Moxo notification, then callback of the ```parseNotification()``` would be triggered with info parameter. Usually info contains 'chat_id' or 'meet_id', depends one which kind of notification you received.
+If is a Moxo notification, then callback of the ``parseNotification()`` would be triggered with info parameter. Usually info contains 'chat_id' or 'meet_id', depends one which kind of notification you received.
 To do more, you can invoke function openChat(chat_id) to open target chat directly.
 
-#### Sample notification payload 
+#### Sample notification payload
 
 ##### iOS
 
@@ -135,7 +190,7 @@ To do more, you can invoke function openChat(chat_id) to open target chat direct
 }
 ```
 
-##### Android 
+##### Android
 
 ```json
 [
@@ -172,8 +227,6 @@ To do more, you can invoke function openChat(chat_id) to open target chat direct
 }]
 ```
 
-## License
-
-ISC
+## API Doc
 
----
+[API doc](https://htmlpreview.github.io/?https://github.com/Moxtra/react-native-moxo-module/blob/main/docs/index.html)

package/android/build.gradle

@@ -148,7 +148,7 @@ dependencies {
   //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation "com.moxtra:mep-sdk:8.9.5"
+  implementation "com.moxtra:mep-sdk:8.12.2"
 // From node_modules
 }
 

package/android/src/main/java/com/moxomodule/MoxoModuleModule.kt

@@ -185,8 +185,8 @@ class MoxoModuleModule(reactContext: ReactApplicationContext) :
   }
 
   @ReactMethod
-  fun removeListener(eventName: String) {
-    Log.d(TAG, "removeListener called...")
+  fun removeListeners(count: Integer) {
+    Log.d(TAG, "removeListeners called...")
   }
 
   @ReactMethod

package/ios/MoxoModule.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

package/ios/MoxoModule.xcodeproj/xcuserdata/john.hu.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>SchemeUserState</key>
+	<dict>
+		<key>MoxoModule.xcscheme_^#shared#^_</key>
+		<dict>
+			<key>orderHint</key>
+			<integer>0</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moxtradeveloper/react-native-moxo-module",
-  "version": "8.9.5",
+  "version": "8.12.2",
   "description": "Plugin for adding Moxtra services to react-native Apps.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -49,21 +49,18 @@
   "author": "john.hu <john.hu@moxo.com>",
   "license": "ISC",
   "bugs": {
-      "url": "https://www.moxtra.com"
+    "url": "https://www.moxtra.com"
   },
   "homepage": "https://www.moxtra.com",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@arkweid/lefthook": "^0.7.7",
-    "@commitlint/config-conventional": "^17.0.2",
     "@react-native-community/eslint-config": "^3.0.2",
     "@release-it/conventional-changelog": "^5.0.0",
     "@types/jest": "^28.1.2",
     "@types/react": "~17.0.21",
     "@types/react-native": "0.70.0",
-    "commitlint": "^17.0.2",
     "del-cli": "^5.0.0",
     "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.5.0",
@@ -75,6 +72,7 @@
     "react-native": "0.70.6",
     "react-native-builder-bob": "^0.20.0",
     "release-it": "^15.0.0",
+    "typedoc": "^0.24.8",
     "typescript": "^4.5.2"
   },
   "resolutions": {

package/react-native-moxo-module.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
   s.public_header_files = 'ios/*.h'
   s.swift_version = '5.0'
   s.dependency "React-Core"
-  s.dependency 'MEPSDK', '~> 8.9.5'
+  s.dependency 'MEPSDK', '~> 8.12.1'
 
   # Don't install the dependencies when we run `pod install` in the old architecture.
   if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then