Merge pull request #2085 from GetStream/develop

Next release
GetStream · May 2, 2023 · f2cd8ed · f2cd8ed
2 parents c417f04 + 30f8e5d
commit f2cd8ed
Show file tree

Hide file tree

Showing 157 changed files with 5,659 additions and 10,030 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -28,6 +28,7 @@ A clear and concise description of what the bug is.
 - Package version (stream-chat-react-native/stream-chat-expo)
 - react-native or expo version
 - Device/Emulator (android/ios) and OS version
+- Offline support enabled (yes/no)
 
 **To Reproduce**
 Steps to reproduce the behavior:

diff --git a/.github/workflows/docusaurus.yml b/.github/workflows/docusaurus.yml
@@ -5,8 +5,6 @@ on:
     branches:
       - main # default branch name for each repo that docs should be push from
       - develop
-    paths:
-      - docusaurus/**
 env:
   branch_map: '{"refs/heads/main": "production", "refs/heads/develop": "staging"}'
 jobs:

diff --git a/.github/workflows/sample-distribution.yml b/.github/workflows/sample-distribution.yml
@@ -1,17 +1,20 @@
 name: sample-distribution
 
-on:
-  push:
-    branches:
-      - develop
-
 concurrency:
-  group: sample-distribution
+  group: sample-distribution-${{ github.ref }}
   cancel-in-progress: true
 
+on:
+  push:
+    paths:
+      - '.github/workflows/sample-distribution.yml'
+      - 'package/**'
+      - 'packages/examples/SampleApp/**'
+
 jobs:
   build_and_deploy_ios_testflight_qa:
-    runs-on: [macos-latest]
+    name: Build SampleApp iOS and Deploy-${{ github.ref == 'refs/heads/develop' }}
+    runs-on: [macos-12]
     steps:
       - uses: actions/checkout@v2
         with:
@@ -48,9 +51,10 @@ jobs:
           APP_STORE_CONNECT_API_KEY_KEY: ${{ secrets.APP_STORE_CONNECT_API_KEY_KEY }}
         run: |
           cd examples/SampleApp
-          bundle exec fastlane deploy_to_testflight_qa
+          bundle exec fastlane deploy_to_testflight_qa deploy:${{ github.ref == 'refs/heads/develop' }};
 
   build_and_deploy_android_s3:
+    name: Build SampleApp Android and Deploy-${{ github.ref == 'refs/heads/develop' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -72,11 +76,13 @@ jobs:
 
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v1
+        if: ${{ github.ref == 'refs/heads/develop' }}
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: us-east-1
       - name: Upload APK
+        if: ${{ github.ref == 'refs/heads/develop' }}
         # https://getstream.io/downloads/rn-sample-app.apk
         run: |
           cp examples/SampleApp/android/app/build/outputs/apk/release/app-release.apk rn-sample-app.apk

diff --git a/.styles/Vocab/Base/accept.txt b/.styles/Vocab/Base/accept.txt
@@ -22,6 +22,7 @@ serializable
 Upserts
 Unsets
 SDK's
+SDKs
 Worklet
 aiba
 (nl)
@@ -38,3 +39,4 @@ performant
 virtualized
 rncli
 RNCLI
+CDNs
diff --git a/docusaurus/docs/reactnative/basics/getting_started.mdx b/docusaurus/docs/reactnative/basics/getting_started.mdx
@@ -115,16 +115,18 @@ For RNCLI, on iOS on a Mac install the pods `npx pod-install ios`.
 
 To be able to use the Stream Chat React Native SDK, a few dependencies must meet the following version requirements:
 
-| react-native | stream-chat-react-native/stream-chat-expo (min required) | react-native-reanimated (min required) |
-| ------------ | -------------------------------------------------------- | -------------------------------------- |
-| 0.70         | 5.3.1                                                    | 2.10.0                                 |
-| 0.69         | 4.13.0                                                   | 2.9.1                                  |
-| 0.68         | 4.11.0                                                   | 2.7.0                                  |
-| 0.67         | 4.2.0                                                    | 2.4.0                                  |
-| 0.66         | 3.9.0                                                    | 2.2.3                                  |
-| 0.65         | 3.9.0                                                    | 2.2.1                                  |
-| 0.64         | 3.6.2                                                    | 2.2.0                                  |
-| 0.63         | 3.0.0                                                    | 2.2.0                                  |
+| react-native | stream-chat-react-native/stream-chat-expo (min required) | react-native-reanimated (min required) | react-native-quick-sqlite (min required) |
+| ------------ | -------------------------------------------------------- | -------------------------------------- | ---------------------------------------- |
+| 0.71         | 5.14.0                                                   | 2.13.0                                 | 8.0.2                                    |
+| 0.70         | 5.6.1                                                    | 2.10.0                                 | 5.1.0                                    |
+| 0.70         | 5.3.1                                                    | 2.10.0                                 | 4.0.0                                    |
+| 0.69         | 4.13.0                                                   | 2.9.1                                  | N/A                                      |
+| 0.68         | 4.11.0                                                   | 2.7.0                                  | N/A                                      |
+| 0.67         | 4.2.0                                                    | 2.4.0                                  | N/A                                      |
+| 0.66         | 3.9.0                                                    | 2.2.3                                  | N/A                                      |
+| 0.65         | 3.9.0                                                    | 2.2.1                                  | N/A                                      |
+| 0.64         | 3.6.2                                                    | 2.2.0                                  | N/A                                      |
+| 0.63         | 3.0.0                                                    | 2.2.0                                  | N/A                                      |
 
 #### Platform compatibilities
 
@@ -151,7 +153,7 @@ For some of the packages listed below, there are additional steps required to se
 
 - `react-native-gesture-handler` - [additional installation steps](https://docs.swmansion.com/react-native-gesture-handler/docs/#android)
 
-  RNGH requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.js` or `index.js` file.
+  RNGH requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.tsx` or `index.js` file.
 
   ```tsx
   import 'react-native-gesture-handler';

diff --git a/docusaurus/docs/reactnative/basics/offline_support.mdx b/docusaurus/docs/reactnative/basics/offline_support.mdx
@@ -8,7 +8,8 @@ React Native Chat SDK provides OOTB support for offline mode, which means user w
 with chat even when the network is off. This is an opt-in feature that needs to be explicitly enabled on application
 level.
 
-> Offline support is currently not implemented for Expo package (stream-chat-expo).
+> Integration with Expo is possible using the [expo-dev-client](https://docs.expo.dev/development/getting-started/) library.
+> Offline support cannot be used in the "Expo Go" app, because [it requires custom native code](https://docs.expo.io/workflow/customizing/).
 
 ## Features
 

diff --git a/docusaurus/docs/reactnative/basics/troubleshooting.mdx b/docusaurus/docs/reactnative/basics/troubleshooting.mdx
@@ -351,6 +351,13 @@ Reanimated plugin has to be listed last.
 
 ### Blank screen on Android
 
+:::caution
+
+This step is only required for older version of (Reanimated 2).
+If you are using version >=3.0.0, you can skip this step.
+
+:::
+
 If you are encountering errors on Android and the screen is blank it is likely you forgot to finish the [Reanimated 2 Android setup](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/installation/#android).
 
 Ensure Hermes is enabled in `android/app/build.gradle`:

diff --git a/docusaurus/docs/reactnative/customization/global_config.mdx b/docusaurus/docs/reactnative/customization/global_config.mdx
@@ -0,0 +1,40 @@
+---
+id: global_config
+sidebar_position: 6
+title: Global Config
+---
+
+The core of Stream Chat for React Native is it's ability to be customized to your needs.
+The new `Global Config` feature allows you to enable and disable features of the library and alter the default behavior of the SDK.
+
+We will be gradually adding more features/options to the global config.
+In the future this will be the main way to alter the default behavior of the SDK and it's components.
+
+## When to use a Global Configt
+
+When you want to alter the default behavior of the SDK or it's components.
+Please check the available options below to see if there is a config option that fits your needs.
+
+## How to use and alter the global config
+
+Altering the global config can be done by calling the `setConfig` function on the `StreamChatRN` object.
+Make sure to call this function before any other components are rendered at the root of your application (App.tsx in most cases).
+
+```tsx
+import { StreamChatRN } from 'stream-chat-react-native';
+
+StreamChatRN.setConfig({
+  resizableCDNHosts: ['https://my-company-cdn.com'],
+  // future config options
+});
+```
+
+## Available config features/Options
+
+### `resizableCDNHosts`
+
+This option allows you to specify a list of CDNs that offer image resizing.
+
+| Type       | Default                  |
+| ---------- | ------------------------ |
+| `string[]` | `['.stream-io-cdn.com']` |
diff --git a/docusaurus/reactnative_versioned_docs/version-3.x.x/basics/getting_started.mdx b/docusaurus/reactnative_versioned_docs/version-3.x.x/basics/getting_started.mdx
@@ -108,7 +108,7 @@ To be able to use the Stream Chat React Native SDK, a few dependencies must meet
 
 :::info
 
-`react-native-gesture-handler` requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.js` or `index.js` file.
+`react-native-gesture-handler` requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.tsx` or `index.js` file.
 
 <br />
 

diff --git a/docusaurus/reactnative_versioned_docs/version-3.x.x/guides/upgrade_helper.mdx b/docusaurus/reactnative_versioned_docs/version-3.x.x/guides/upgrade_helper.mdx
@@ -70,7 +70,7 @@ AppRegistry.registerComponent(appName, () => App);
 
 #### Import gesture handler dependency
 
-v3 requires you to import the gesture handler dependency at the top of your application's entry file (usually your App.js or index.js) before any other dependencies:
+v3 requires you to import the gesture handler dependency at the top of your application's entry file (usually your App.tsx or index.js) before any other dependencies:
 
 ```tsx {1}
 import 'react-native-gesture-handler';

diff --git a/docusaurus/reactnative_versioned_docs/version-4.x.x/basics/getting_started.mdx b/docusaurus/reactnative_versioned_docs/version-4.x.x/basics/getting_started.mdx
@@ -120,7 +120,7 @@ For some of the packages listed below, there are additional steps required to se
 
 - `react-native-gesture-handler` - [additional installation steps](https://docs.swmansion.com/react-native-gesture-handler/docs/#android)
 
-  RNGH requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.js` or `index.js` file.
+  RNGH requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.tsx` or `index.js` file.
 
   ```tsx
   import 'react-native-gesture-handler';
@@ -241,7 +241,7 @@ For some of the packages listed below, there are additional steps required to se
 
 - `react-native-gesture-handler` - [additional installation steps](https://docs.expo.dev/versions/latest/sdk/gesture-handler/#api)
 
-  RNGH requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.js` or `index.js` file.
+  RNGH requires the package to be imported at the **top of the entry file** before anything else, this is usually your `App.tsx` or `index.js` file.
 
   ```tsx
   import 'react-native-gesture-handler';