Merge branch 'develop'

Author: bang9

.circleci/config.yml

@@ -18,7 +18,6 @@ aliases:
         - sample/node_modules
         - packages/uikit-chat-hooks/node_modules
         - packages/uikit-react-native/node_modules
-        - packages/uikit-react-native-core/node_modules
         - packages/uikit-react-native-foundation/node_modules
         - packages/uikit-utils/node_modules
   - &create_app_env

.gitignore

@@ -21,3 +21,5 @@ version.ts
 
 *.app.dSYM.zip
 lerna-debug.log
+
+/docs

OPENSOURCE_GUIDELINES.md

@@ -0,0 +1,11 @@
+# Sendbird UIKit Open Source Guidelines
+​
+Sendbird is excited to share UIKit to the open source community in order to speed up the go-to-market strategy for our customers. We’ve already seen how UIKit enables you to go to market with ease, but now we want to provide you with the flexibility to fine tune UIKit for your own market needs.
+​
+This community guideline outlines Sendbird’s stance on open source and explains how you can take advantage of UIKit’s open source.
+​
+*   We recommend you to use UIKit open source only if the standard UIKit SDK does not suit your use case. This includes if you’d like to use a Sendbird Chat SDK feature that is currently unavailable in UIKit.
+*   We will provide limited support should you choose to use our open source code and fork it (clone and edit the code in your own repository) because we won’t be able to transparently understand the code.
+*   We don’t accept direct contributions to the source code. If you discover a bug or would like to suggest improvements to the source code, you can share them in the [Sendbird Community UIKit forum](https://community.sendbird.com/c/sendbird-chat-uikit/)).
+    ​
+    _UIKit is licensed under the MIT open source license_

README.md

@@ -1,30 +1,163 @@
 # sendbird-uikit-react-native
 
-uikit
+[![Platform React-Native](https://img.shields.io/badge/Platform-React--Native-orange.svg)](https://reactnative.dev/)
+[![Language TypeScript](https://img.shields.io/badge/Language-TypeScript-orange.svg)](https://www.typescriptlang.org/)
 
-[![Status_Build](https://github.com/sendbird/sendbird-uikit-react-native/actions/workflows/status-build.yml/badge.svg)](https://github.com/sendbird/sendbird-uikit-react-native/actions/workflows/status-build.yml)
-[![Status_Test](https://github.com/sendbird/sendbird-uikit-react-native/actions/workflows/status-test.yml/badge.svg)](https://github.com/sendbird/sendbird-uikit-react-native/actions/workflows/status-test.yml)
+> React-Native based UI kit based on sendbird javascript SDK
 
----
+## Introduction
+
+Sendbird UIKit for React-Native is a development kit with an user interface that enables an easy and fast integration of standard chat features into new or existing client apps.
+This mono-repository the UIKit source code is consists as explained below.
+
+- [**packages/uikit-react-native**](/packages/uikit-react-native) is where you can find the open source code. Check out [UIKit Open Source Guidelines](/OPENSOURCE_GUIDELINES.md) for more information regarding our stance on open source.
+- [**sample**](/sample) is a chat app with UIKit’s core features in which you can see items such as push notifications, total unread message count and auto sign-in are demonstrated. When you sign in to the sample app, you will only see a list of channels rendered by the [GroupChannelListFragment](https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels) on the screen.
+- [**packages/uikit-react-native-foundation**](/packages/uikit-react-native-foundation) is a UI package for `uikit-react-native`.
+- [**packages/uikit-chat-hooks**](/packages/uikit-chat-hooks) is a react hooks package for `uikit-react-native`.
+- [**packages/uikit-utils**](/packages/uikit-utils) is a utility package for `uikit-react-native`.
+
+### More about Sendbird UIKit for React-Native
+
+Find out more about Sendbird UIKit for React-Native at [UIKit for React Native doc](https://sendbird.com/docs/uikit/v3/react-native/overview).
+If you need any help in resolving any issues or have questions, visit [our community](https://community.sendbird.com).
+
+<br/>
+
+## Requirements
+
+- Nodejs 14 or newer
+- [yarn v1](https://classic.yarnpkg.com/en/docs/install)
+- Watchman
+- JDK 11 or newer
+- XCode
+- Android Studio
+
+More details, please see https://reactnative.dev/docs/environment-setup
+
+<br/>
+
+## Try the sample app
+
+We are using sample app for development, you can check the sample app [here](/sample) and also check the UI components via storybook in the sample app.
+
+### Installation
+
+> Every script should be run on the root of the project.
+
+**Install node modules**
+
+```shell
+yarn install
+```
+
+**Linking native modules of sample app**
+
+```shell
+yarn sample:pod-install
+```
+
+**Running sample app**
+
+- Android
+
+```shell
+yarn sample:android
+```
+
+- iOS
+
+```shell
+yarn sample:ios
+```
+
+### Sample app using your data
+
+Create a file to `sample/src/env.ts` and write the code below to the file you created.
+
+```ts
+export const APP_ID = '2D7B4CDB-932F-4082-9B09-A1153792DC8D';
+```
+
+If you would like to try the sample app specifically fit to your usage, you can do so by replacing the default sample app ID with yours, which you can obtain by creating your [Sendbird application from the dashboard](https://dashboard.sendbird.com/).
+
+<br />
+
+## Development
+
+We tried development on macOS / Linux systems. You might encounter problems in running sample or scripts like `yarn build` in Windows machines.
+
+### Creating a new key function files
+
+Run the script and enter the key function name as a lower camel case like `groupChannel`, and then you can see the auto generated files in the `/packages/uikit-react-native/src/domain`
+
+```shell
+yarn workspace @sendbird/uikit-react-native run create-domain
+```
+
+### Managing repository
+
+> **Note**
+> We are using [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces) and [lerna](https://github.com/lerna/lerna) to maintain this monorepo
+
+#### Package dependencies
+
+See [yarn workspace](https://classic.yarnpkg.com/en/docs/cli/workspace)
+
+```shell
+# Add dependency to specific workspace package
+yarn workspace @sendbird/package add package-name
+# Remove dependency from specific workspace package
+yarn workspace @sendbird/package remove package-name
+
+# Add dependency to root
+yarn workspace -W add package-name
+```
+
+> **Warning** You should better install to root if you're trying to install native view modules.
+> Sometimes native view module in the workspace is not hoisted, and it leads to `Tried to register two views` error on the sample app.
+
+#### Bump version
+
+See [lerna version](https://github.com/lerna/lerna/tree/main/commands/version)
+
+```shell
+lerna version {major|minor|patch} [--no-git-tag-version] [--no-private]
+
+# or
+
+yarn bump:{major|minor|patch}
+```
+
+#### Publish
+
+See [lerna publish](https://github.com/lerna/lerna/tree/main/commands/publish)
+
+<br/>
 
 ## Scripts
 
-### Lint & Prettier
+### Build
 
-- check: `yarn lint`
-- fix: `yarn fix`
+```shell
+yarn build
+```
 
 ### Test
 
-- test: `yarn test`
+```shell
+# Unit test
+yarn test
 
-### Package dependencies
+# Build test
+yarn test:build
+```
 
-- add: `yarn workspace @sendbird/package add some-package`
-- remove: `yarn workspace @sendbird/package remove some-package`
+### Lint and Prettier
 
-### Publish
-> Bump > Build > Deploy 
+```shell
+# Check formatting
+yarn lint
 
-- bump script: `lerna version {major|minor|patch} [--no-git-tag-version] [--no-private]` or `yarn bump:{major|minor|patch}`
-- build script: `yarn build`
+# Fix formatting
+yarn fix
+```

lerna.json

@@ -8,16 +8,11 @@
   "version": "0.1.2",
   "command": {
     "publish": {
-      "allowBranch": "main",
       "conventionalCommits": true,
       "createRelease": "github",
       "message": "chore(release): publish %v"
     },
     "version": {
-      "allowBranch": [
-        "main",
-        "*/lerna"
-      ],
       "conventionalCommits": true,
       "exact": true,
       "gitRemote": "origin",

package.json

@@ -22,6 +22,7 @@
     "reset": "find . -type dir -name node_modules | xargs rm -rf",
     "clean": "lerna run clean",
     "build": "lerna run build",
+    "docs": "yarn build && typedoc --out docs --entryPointStrategy packages 'packages/*' && yarn clean",
     "test": "jest --verbose",
     "test:build": "yarn build --stream && yarn clean --stream",
     "lint": "yarn lint:eslint && yarn lint:prettier",
@@ -30,6 +31,7 @@
     "lint:prettier": "prettier --check \"sample/src/**/*.{ts,tsx}\" \"packages/*/src/**/*.{ts,tsx}\"",
     "fix:eslint": "eslint --fix packages/*/src --ext ts,tsx -c ./.eslintrc.js",
     "fix:prettier": "prettier --write \"sample/src/**/*.{ts,tsx}\" \"packages/*/src/**/*.{ts,tsx}\"",
+    "sample:pod-install": "cd sample/ios && pod install",
     "sample:ios": "cd sample && yarn ios",
     "sample:android": "cd sample && yarn android",
     "deploy:ios": "cd sample/ios && bundle exec fastlane deploy",
@@ -57,8 +59,10 @@
     "react": "17.0.2",
     "react-native": "0.66.4",
     "react-native-builder-bob": "^0.18.2",
+    "react-native-fast-image": "^8.5.11",
     "react-native-safe-area-context": "^3.3.2",
     "react-test-renderer": "^17.0.2",
+    "typedoc": "^0.23.7",
     "typescript": "^4.5.4"
   },
   "resolutions": {

packages/uikit-chat-hooks/README.md

@@ -1,9 +1,9 @@
 # @sendbird/uikit-chat-hooks
 
-uikit-chat-hooks
+React custom hooks with Sendbird Chat SDK v3, made for UIKit
 
 ## Installation
 
 ```sh
-npm install @sendbird/uikit-chat-hooks
+npm i @sendbird/uikit-chat-hooks
 ```

packages/uikit-chat-hooks/package.json

@@ -47,7 +47,7 @@
   },
   "peerDependencies": {
     "react": ">=16.13.1",
-    "sendbird": "^3.1.16"
+    "sendbird": "^3.1.22"
   },
   "react-native-builder-bob": {
     "source": "src",
@@ -62,5 +62,10 @@
         }
       ]
     ]
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "displayName": "@sendbird/uikit-chat-hooks"
   }
 }

packages/uikit-chat-hooks/src/channel/useActiveGroupChannel.ts

@@ -1,9 +1,8 @@
 import { useEffect, useState } from 'react';
-import type Sendbird from 'sendbird';
 
-import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
+import type { SendbirdChatSDK, SendbirdGroupChannel } from '@sendbird/uikit-utils';
 
-export const useActiveGroupChannel = (sdk: SendbirdChatSDK, staleChannel: Sendbird.GroupChannel) => {
+export const useActiveGroupChannel = (sdk: SendbirdChatSDK, staleChannel: SendbirdGroupChannel) => {
   const [activeChannel, setActiveChannel] = useState(() => staleChannel);
 
   useEffect(() => {

packages/uikit-chat-hooks/src/channel/useGroupChannelList.ts

@@ -1,14 +1,8 @@
-import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
-
-import type { UseGroupChannelList, UseGroupChannelListOptions } from '../types';
+import type { UseGroupChannelList } from '../types';
 import { useGroupChannelListWithCollection } from './useGroupChannelListWithCollection';
 import { useGroupChannelListWithQuery } from './useGroupChannelListWithQuery';
 
-export const useGroupChannelList = (
-  sdk: SendbirdChatSDK,
-  userId?: string,
-  options?: UseGroupChannelListOptions,
-): UseGroupChannelList => {
+export const useGroupChannelList: UseGroupChannelList = (sdk, userId, options) => {
   if (sdk.isCacheEnabled || options?.enableCollectionWithoutLocalCache) {
     return useGroupChannelListWithCollection(sdk, userId, options);
   } else {