You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ProductNotes/compatibility.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ sidebar_position: 2
9
9
Supported iOS and Android versions are dependent on React Native. See the [React Native Documentation](https://github.com/reactwg/react-native-releases/blob/main/docs/support.md) documentation for more information.
10
10
:::
11
11
12
-
The cbl-reactnative library is built against Couchbase Lite Enterprise for iOS and Android. Version 1.1 uses Couchbase Lite Android Enterprise 3.3.0 and Couchbase Lite Swift Enterprise 3.3.1.
12
+
The cbl-reactnative library is built against Couchbase Lite Enterprise for iOS and Android. Version 1.1 uses Couchbase Lite Android Enterprise 3.3.3 and Couchbase Lite Swift Enterprise 3.3.3.
13
13
14
14
Version 1.1 supports [React Native New Architecture](https://reactnative.dev/architecture/overview) through TurboModules. Apps should use React Native 0.76.3 or higher and enable New Architecture for the TurboModule path.
Copy file name to clipboardExpand all lines: versioned_docs/version-1.0/DataSync/remote-sync-gateway.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -506,10 +506,6 @@ await replicator.start();
506
506
507
507
1. The callback should follow the semantics of a [pure function](https://en.wikipedia.org/wiki/Pure_function). Otherwise, long running functions would slow down the replicator considerably.
508
508
509
-
:::note Version 1.1
510
-
Android replication filters now support JavaScript arrow functions in the V8 evaluation path.
511
-
:::
512
-
513
509
##### Pull Filter
514
510
515
511
The pull filter gives an app the ability to validate documents being pulled, and skip ones that fail. This is an important security mechanism in a peer-to-peer topology with peers that are not fully trusted.
Copy file name to clipboardExpand all lines: versioned_docs/version-1.0/ProductNotes/compatibility.md
+1-5Lines changed: 1 addition & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,7 @@ sidebar_position: 2
9
9
Supported iOS and Android versions are dependent on React Native. See the [React Native Documentation](https://github.com/reactwg/react-native-releases/blob/main/docs/support.md) documentation for more information.
10
10
:::
11
11
12
-
The cbl-reactnative library is built against Couchbase Lite Enterprise for iOS and Android. Version 1.1 uses Couchbase Lite Android Enterprise 3.3.0 and Couchbase Lite Swift Enterprise 3.3.1.
13
-
14
-
Version 1.1 supports React Native New Architecture through TurboModules. Apps should use React Native 0.76.3 or higher and enable New Architecture for the TurboModule path.
15
-
16
-
To see the compatibility notes for the native SDK, see the following documentation:
12
+
The cbl-reactnative library is build against the native SDK for iOS and Android. The current version of the native SDK is 3.2.0. To see the compatibility notes for the native SDK, see the following documentation:
17
13
18
14
-[Couchbase Mobile Compatibility Guide - iOS](https://docs.couchbase.com/couchbase-lite/current/swift/supported-os.html).
- Enable React Native New Architecture to use the TurboModule implementation.
31
-
- Review logging setup if you want React Native wrapper logs included in file or custom log sinks.
32
-
33
-
See [Migration Guide](../Guides/Migration/v1.1.md) for detailed instructions.
34
-
35
-
---
36
-
37
8
**1.0.0** (December 2025)
38
9
39
10
New Features:
@@ -75,14 +46,14 @@ See [Migration Guide](../Guides/Migration/v1.md) for detailed instructions.
75
46
---
76
47
77
48
**0.6.3**
78
-
- Array handling and improve blob data validation in DataAdapter [null-pointer issue](https://github.com/couchbase/couchbase-lite-react-native/pull/73)
49
+
- Array handling and improve blob data validation in DataAdapter [null-pointer issue](https://github.com/Couchbase-Ecosystem/cbl-reactnative/pull/73)
79
50
- Fix a crash caused by improper handling of encryption key
80
51
81
52
**0.6.1**
82
-
- Implemented [Collection Change Listeners](https://github.com/couchbase/couchbase-lite-react-native/pull/54) on Android
83
-
- Implemented [Query Change Listeners](https://github.com/couchbase/couchbase-lite-react-native/pull/55) on Android
53
+
- Implemented [Collection Change Listeners](https://github.com/Couchbase-Ecosystem/cbl-reactnative/pull/54) on Android
54
+
- Implemented [Query Change Listeners](https://github.com/Couchbase-Ecosystem/cbl-reactnative/pull/55) on Android
84
55
- Fixed data adapter issues and improved testing
85
-
- Fixed [issue](https://github.com/couchbase/couchbase-lite-react-native/issues/38) related to collection `getDocument` always pulling blob content
56
+
- Fixed [issue](https://github.com/Couchbase-Ecosystem/cbl-reactnative/issues/38) related to collection `getDocument` always pulling blob content
Change listeners now return a `ListenerToken` object with a `remove()` method for cleanup.
45
45
:::
46
46
47
-
:::note Version 1.1
48
-
Live query listeners use the TurboModule typed event path on New Architecture builds. This improves listener routing and cleanup consistency across iOS and Android.
49
-
:::
50
-
51
47
#### Example 2. Stopping a Live Query - Change Listener
Copy file name to clipboardExpand all lines: versioned_docs/version-1.0/StartHere/install.md
+2-16Lines changed: 2 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ sidebar_position: 2
5
5
# Install
6
6
7
7
:::note
8
-
This Native Module is currently under active development. If you find problems, please open an issue on the [GitHub repo](https://github.com/couchbase/couchbase-lite-react-native/issues).
8
+
This Native Module is currently under active development. If you find problems, please open an issue on the [GitHub repo](https://github.com/Couchbase-Ecosystem/cbl-reactnative/issues).
9
9
:::
10
10
11
11
:::note
@@ -16,8 +16,6 @@ The version of this Native Module is based on supporting Couchbase Lite Enterpri
16
16
17
17
The setup for using the Couchbase Lite React Native Native Module is a bit more involved than a typical React Native project. This is because the Native Module is a wrapper around the Couchbase Lite SDKs for iOS and Android. The Couchbase Lite SDKs are written in Swift and Kotlin, respectively, and are not directly compatible with JavaScript. The Native Module provides a bridge between the two languages.
18
18
19
-
Version 1.1 supports React Native New Architecture through TurboModules. In React Native and Expo development builds, enable New Architecture when you want to use the TurboModule implementation.
20
-
21
19
The installation for the Native Module is provided in two sections: one section for standard React Native apps and one for Expo based apps.
22
20
23
21
### React Native Based Apps
@@ -42,9 +40,7 @@ cd ..
42
40
43
41
#### Android
44
42
45
-
For React Native New Architecture builds, make sure `newArchEnabled=true` is set in your Android project configuration.
46
-
47
-
If your app needs manual Gradle wiring, update the Android Gradle file to include the native module. This can be done by editing the build.gradle file in the android directory of your React native app and adding the following line below the apply plugin line for the com.facebook.react.rootproject:
43
+
In the current beta release, the Android Gradle file needs to be updated manually to include the native module. This can be done by editing the build.gradle file in the android directory of your React native app and adding the following line below the apply plugin line for the com.facebook.react.rootproject:
Copy file name to clipboardExpand all lines: versioned_docs/version-1.0/StartHere/prerequisties.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,13 @@ sidebar_position: 1
5
5
6
6
# Prerequisites
7
7
8
-
Couchbase Lite for React Native is provided as a [Native Module](https://reactnative.dev/docs/native-modules-intro).
8
+
Couchbase Lite for React Native is provided as a [Native Module](https://reactnative.dev/docs/legacy/native-modules-intro).
9
9
10
-
The Native Module can be found at the following repository:[Couchbase Lite for React Native](https://github.com/couchbase/couchbase-lite-react-native). Shared TypeScript and JavaScript code lives in [couchbase-lite-js-common](https://github.com/couchbase/couchbase-lite-js-common).
10
+
The Native Module can be found at the following repository [Couchbase Lite for React Native](https://github.com/Couchbase-Ecosystem/cbl-reactnative). This plugin is actively developed and maintained by the community. It is not an official Couchbase product.
11
11
12
12
A developer using this plugin should have a basic understanding of the following technologies:
@@ -24,7 +23,6 @@ React Native's recommmendation is to use [Expo](https://reactnative.dev/blog/202
24
23
25
24
## React Native Version
26
25
- The plugin is built using React Native 0.76.3. Support for older versions of React Native is not guaranteed and apps should be based on 0.76.3 or higher.
27
-
- Version 1.1 supports TurboModules through React Native New Architecture. Apps should enable New Architecture when using the TurboModule implementation.
28
26
29
27
Please review the React Native [Support documentation](https://github.com/reactwg/react-native-releases/blob/main/docs/support.md) for a full listed of supported platform versions.
Copy file name to clipboardExpand all lines: versioned_docs/version-1.0/Troubleshooting/using-logs.md
-42Lines changed: 0 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,8 +34,6 @@ Log output is split into the following streams:
34
34
35
35
Version 1.0 introduces the Log Sink API which provides three types of log sinks for flexible logging control.
36
36
37
-
Version 1.1 improves file logging by forwarding React Native wrapper diagnostics into configured file and custom log sinks. These wrapper-originated lines are prefixed with `RN ::LEVEL::`, for example `RN ::DEBUG:: database_Open`, so they can be distinguished from native Couchbase Lite SDK logs.
38
-
39
37
### Log Levels
40
38
41
39
| Level | Value | Description |
@@ -125,30 +123,6 @@ When a log file reaches `maxFileSize`, it's closed and a new one is created. Old
125
123
awaitLogSinks.setFile(null);
126
124
```
127
125
128
-
### React Native Wrapper Logs in File Logging
129
-
130
-
When file logging is enabled, version 1.1 can include diagnostics from the React Native wrapper in the same log files as native Couchbase Lite logs. This helps troubleshoot issues that cross the JavaScript/native boundary, such as listener registration, database open/close calls, query execution, and replication operations.
131
-
132
-
Wrapper log lines use the `RN` marker:
133
-
134
-
```text
135
-
RN ::DEBUG:: database_Open
136
-
RN ::WARNING:: query_RemoveChangeListener rejected: no listener for token
137
-
RN ::ERROR:: collection_Save failed
138
-
```
139
-
140
-
The wrapper avoids forwarding sensitive payloads such as document bodies, blob contents, encryption keys, and raw filesystem paths.
141
-
142
-
You can use `FileSystem.getFilesInDirectory(path)` to list generated log files in the log directory:
Custom logging allows you to implement your own logging logic with a callback function.
@@ -174,22 +148,6 @@ await LogSinks.setCustom({
174
148
awaitLogSinks.setCustom(null);
175
149
```
176
150
177
-
## Writing App Logs to Couchbase Lite Sinks
178
-
179
-
Version 1.1 adds `LogSinks.write()` for writing your own application log messages into the configured Couchbase Lite logging pipeline. These messages are delivered to enabled sinks such as file, console, and custom sinks.
`LogSinks.write()` accepts concrete domains such as `DATABASE`, `QUERY`, `REPLICATOR`, `NETWORK`, and `LISTENER`. `LogDomain.ALL` is for sink configuration and is not accepted for a single written log line.
192
-
193
151
## Using Multiple Log Sinks
194
152
195
153
You can enable multiple log sinks simultaneously for different purposes.
In version 1.1, passing `null` clears a document's expiration. Expiration values are parsed as strict UTC ISO-8601 dates when crossing the native bridge.
Documents can be purged from the local database using the `purge` method on the collection they are stored in.
@@ -474,8 +468,6 @@ await collection.delete(doc);
474
468
```
475
469
Note that document deletion are replicated to Sync Gateway or Capella App Services.
476
470
477
-
When using `ConcurrencyControl.FAIL_ON_CONFLICT`, version 1.1 checks the document revision ID before deleting. A delete using a stale document revision rejects instead of deleting a newer revision.
478
-
479
471
## Document Constraints
480
472
481
473
Couchbase Lite APIs do not explicitly disallow the use of attributes with the underscore prefix at the top level of document. This is to facilitate the creation of documents for use either in local only mode where documents are not synced.
0 commit comments