Merge pull request #13 from jayant-dhingra-cb/docs_1_1

Docs 1 1

Author: adamcfraser

README.md

@@ -47,7 +47,7 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
 We truly appreciate your interest in this project!  
 This project is **community-maintained**, which means it's **not officially supported** by our support team.
 
-If you need help, have found a bug, or want to contribute improvements, the best place to do that is right here - by [opening a GitHub issue](https://github.com/Couchbase-Ecosystem/cbl-reactnative-docs/issues).  
+If you need help, have found a bug, or want to contribute improvements, the best place to do that is right here - by [opening a GitHub issue](https://github.com/couchbase/cbl-reactnative-docs/issues).  
 Our support portal is unable to assist with requests related to this project, so we kindly ask that all inquiries stay within GitHub.
 
 Your collaboration helps us all move forward together - thank you!

docs/DataSync/remote-sync-gateway.md

@@ -137,7 +137,7 @@ import {
   BasicAuthenticator,
   Replicator,
   ListenerToken
-} from 'cbl-reactnative';
+} from '@couchbase/couchbase-lite-react-native';
 
 // Create endpoint and authenticator
 const endpoint = new URLEndpoint('ws://localhost:4984/projects');
@@ -202,7 +202,7 @@ The `addCollection()` method is deprecated. It remains available for backward co
 The new API allows each collection to have its own replication settings:
 
 ```typescript
-import { CollectionConfiguration } from 'cbl-reactnative';
+import { CollectionConfiguration } from '@couchbase/couchbase-lite-react-native';
 
 // Configure users collection
 const usersConfig = new CollectionConfiguration(usersCollection)
@@ -726,7 +726,7 @@ The returned *ReplicationStatus* structure comprises:
 #### Example 14. Monitor replication
 
 ```typescript
-import { ListenerToken } from 'cbl-reactnative';
+import { ListenerToken } from '@couchbase/couchbase-lite-react-native';
 
 const token: ListenerToken = await replicator.addChangeListener((change) => {
     const status = change.status;
@@ -764,7 +764,7 @@ interface ReplicatorStatusChange {
 #### Example 14b. Advanced Replication Status Monitoring
 
 ```typescript
-import { ListenerToken, ReplicatorActivityLevel } from 'cbl-reactnative';
+import { ListenerToken, ReplicatorActivityLevel } from '@couchbase/couchbase-lite-react-native';
 
 const token: ListenerToken = await replicator.addChangeListener((change) => {
   const status = change.status;
@@ -851,7 +851,7 @@ For example, the code snippet in [Example 15](#example-15-register-a-document-li
 #### Example 15. Register a document listener
 
 ```typescript
-import { ListenerToken } from 'cbl-reactnative';
+import { ListenerToken } from '@couchbase/couchbase-lite-react-native';
 
 const token: ListenerToken = await replicator.addDocumentChangeListener((replication) => {
     const direction = replication.isPush ? "Push" : "Pull";
@@ -973,7 +973,7 @@ As always, when there is a problem with replication, logging is your friend. You
 #### Example 21. Set logging verbosity
 
 ```typescript
-import { LogSinks, LogLevel, LogDomain } from 'cbl-reactnative';
+import { LogSinks, LogLevel, LogDomain } from '@couchbase/couchbase-lite-react-native';
 
 // Verbose / Replicator and Network
 await LogSinks.setConsole({

docs/Guides/Migration/v1.1.md

@@ -5,7 +5,7 @@ sidebar_position: 2
 
 # Version 1.1
 
-> Description - _Quick reference for customer-facing changes in cbl-reactnative version 1.1_  
+> Description - _Quick reference for customer-facing changes in @couchbase/couchbase-lite-react-native version 1.1_  
 > Related Content - [Release Notes](../../ProductNotes/release-notes.md) | [Using Logs](../../Troubleshooting/using-logs.md)
 
 ## At a Glance
@@ -16,6 +16,25 @@ Version 1.1 is focused on React Native New Architecture support and better troub
 2. **Improved file logging** - React Native wrapper diagnostics can be written to file and custom log sinks.
 3. **LogSinks.write()** - application code can write messages into configured Couchbase Lite log sinks.
 4. **Reliability fixes** - listener cleanup, document expiration, and conflict-aware deletes are improved.
+5. **Official npm package** - published as `@couchbase/couchbase-lite-react-native`, replacing the legacy `cbl-reactnative` package.
+
+## NPM Package Rename
+
+Version 1.1 is published on npm as [`@couchbase/couchbase-lite-react-native`](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native). The legacy unscoped package `cbl-reactnative` (1.0.1 and earlier) is superseded. New installs and upgrades should use the scoped package.
+
+| What to update | Before (`cbl-reactnative`) | After (`@couchbase/couchbase-lite-react-native`) |
+|---|---|---|
+| Install | `npm install cbl-reactnative` | `npm install @couchbase/couchbase-lite-react-native` |
+| TypeScript imports | `from 'cbl-reactnative'` | `from '@couchbase/couchbase-lite-react-native'` |
+| Android Gradle path | `node_modules/cbl-reactnative/android/build.gradle` | `node_modules/@couchbase/couchbase-lite-react-native/android/build.gradle` |
+| Expo plugin podspec path | `node_modules/cbl-reactnative/cbl-reactnative.podspec` | `node_modules/@couchbase/couchbase-lite-react-native/cbl-reactnative.podspec` |
+
+**Upgrade checklist:**
+
+1. Remove `cbl-reactnative` from `package.json`
+2. Install `@couchbase/couchbase-lite-react-native`
+3. Update all import paths and native wiring paths
+4. Rebuild native projects (`pod install`, Gradle clean build)
 
 ## TurboModule Support
 
@@ -54,7 +73,7 @@ This helps diagnose issues that cross the JavaScript/native boundary while keepi
 Use `LogSinks.write()` to write application messages into configured Couchbase Lite sinks:
 
 ```typescript
-import { LogSinks, LogLevel, LogDomain } from 'cbl-reactnative';
+import { LogSinks, LogLevel, LogDomain } from '@couchbase/couchbase-lite-react-native';
 
 await LogSinks.write(
   LogLevel.WARNING,
@@ -73,5 +92,6 @@ await LogSinks.write(
 
 ## Repository Links
 
+- [@couchbase/couchbase-lite-react-native on npm](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native)
 - [couchbase/couchbase-lite-react-native](https://github.com/couchbase/couchbase-lite-react-native)
 - [couchbase/couchbase-lite-js-common](https://github.com/couchbase/couchbase-lite-js-common)

docs/Guides/Migration/v1.md

@@ -5,7 +5,7 @@ sidebar_position: 1
 
 # Version 1.0
 
-> Description - _Quick reference for all API changes in cbl-reactnative version 1.0_  
+> Description - _Quick reference for all API changes in @couchbase/couchbase-lite-react-native version 1.0_  
 > Related Content - [Release Notes](../../ProductNotes/release-notes.md) | [Using Logs](../../Troubleshooting/using-logs.md)
 
 :::important AT A GLANCE
@@ -54,7 +54,7 @@ await Database.setLogLevel(LogDomain.DATABASE, LogLevel.INFO);
 
 **NEW (Required in 1.0):**
 ```typescript
-import { LogSinks, LogLevel, LogDomain } from 'cbl-reactnative';
+import { LogSinks, LogLevel, LogDomain } from '@couchbase/couchbase-lite-react-native';
 
 await LogSinks.setConsole({
   level: LogLevel.VERBOSE,
@@ -85,7 +85,7 @@ const replicator = await Replicator.create(config);
 
 **NEW (Recommended in 1.0):**
 ```typescript
-import { CollectionConfiguration } from 'cbl-reactnative';
+import { CollectionConfiguration } from '@couchbase/couchbase-lite-react-native';
 
 const collectionConfig = new CollectionConfiguration(collection);
 const config = new ReplicatorConfiguration([collectionConfig], endpoint);

docs/ProductNotes/compatibility.md

@@ -9,7 +9,7 @@ sidebar_position: 2
 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.
  :::
 
-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.
+The @couchbase/couchbase-lite-react-native 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.
 
 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.
 

docs/ProductNotes/release-notes.md

@@ -23,6 +23,8 @@ Improvements and Fixes:
 - Android replicator filters can use JavaScript arrow functions in the V8 evaluation path.
 
 Repository Updates:
+- Official npm package: [@couchbase/couchbase-lite-react-native](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native)
+- The legacy `cbl-reactnative` package is superseded; new installs and upgrades should use the scoped package
 - Main React Native repository: [couchbase/couchbase-lite-react-native](https://github.com/couchbase/couchbase-lite-react-native)
 - Shared JavaScript library repository: [couchbase/couchbase-lite-js-common](https://github.com/couchbase/couchbase-lite-js-common)
 

docs/Queries/live-queries.md

@@ -23,7 +23,7 @@ Each time you start watching a live query, the query is executed and an initial
 #### Example 1. Starting a Live Query - Change Listener
 
 ```typescript
-import { ListenerToken } from 'cbl-reactnative';
+import { ListenerToken } from '@couchbase/couchbase-lite-react-native';
 
 // Register a change listener
 const token: ListenerToken = await query.addChangeListener((change) => {  
@@ -82,7 +82,7 @@ interface QueryChange {
 #### Example 3. Complete Live Query with Error Handling
 
 ```typescript
-import { ListenerToken } from 'cbl-reactnative';
+import { ListenerToken } from '@couchbase/couchbase-lite-react-native';
 
 const query = database.createQuery(
   'SELECT META().id, name, email FROM _default.users WHERE isActive = true'
@@ -108,7 +108,7 @@ await token.remove();
 
 ```typescript
 import { useEffect, useState } from 'react';
-import { ListenerToken } from 'cbl-reactnative';
+import { ListenerToken } from '@couchbase/couchbase-lite-react-native';
 
 function ActiveUsersScreen({ database }) {
   const [users, setUsers] = useState([]);

docs/StartHere/build-run.md

@@ -29,7 +29,7 @@ import {
 	ReplicatorConfiguration,
 	ReplicatorType,
 	URLEndpoint
-} from 'cbl-reactnative';
+} from '@couchbase/couchbase-lite-react-native';
 
 
 async function runDbSample() : Promise<void> {

docs/StartHere/example-apps.md

@@ -9,7 +9,7 @@ Several example apps are available for developers to review.  These apps are des
 
 ## React Native Module Example App
 
-The cbl-reactnative module has an example app in the repository's [expo-example](https://github.com/couchbase/couchbase-lite-react-native/tree/main/expo-example) folder. This example app is designed to show off all the various APIs and is used to test the Native Module during the development process.   
+The @couchbase/couchbase-lite-react-native module has an example app in the repository's [expo-example](https://github.com/couchbase/couchbase-lite-react-native/tree/main/expo-example) folder. This example app is designed to show off all the various APIs and is used to test the Native Module during the development process.   
 
 ## Expo Travel Sample App
 

docs/StartHere/install.md

@@ -9,7 +9,7 @@ This Native Module is currently under active development.  If you find problems,
  :::
 
 :::note
-The version of this Native Module is based on supporting Couchbase Lite Enterprise for iOS and Android.  This Native Module is not compatible with Couchbase Lite Community Edition.  A [license](https://www.couchbase.com/pricing/) is required to use Couchbase Lite Enterprise edition.
+The version of this Native Module is based on supporting Couchbase Lite Enterprise for iOS and Android.  A [license](https://www.couchbase.com/pricing/) is required to use Couchbase Lite Enterprise edition.
 :::
 
 ## Get Started
@@ -22,12 +22,18 @@ The installation for the Native Module is provided in two sections:  one section
 
 ### React Native Based Apps 
 
-To use the Couchbase Lite React Native Native Module in a standard React Native app, you will need to install the npm package.  From the root of your applications project directory (the directory containing your `package.json` file), run the following command:
+To use the Couchbase Lite React Native Native Module in a standard React Native app, you will need to install the npm package [@couchbase/couchbase-lite-react-native](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native).  From the root of your applications project directory (the directory containing your `package.json` file), run one of the following commands:
 
 ```bash
-npm install cbl-reactnative
+npm install @couchbase/couchbase-lite-react-native
+# or
+yarn add @couchbase/couchbase-lite-react-native
 ```
 
+:::note
+New projects should install the scoped package above. Upgrading from the legacy `cbl-reactnative` package (1.0.1 and earlier)? See the [Version 1.1 Migration Guide](../Guides/Migration/v1.1.md#npm-package-rename).
+:::
+
 Once installed, you will want to build each native project (iOS and Android) to link the native module to your project.  
 
 #### iOS
@@ -47,14 +53,14 @@ For React Native New Architecture builds, make sure `newArchEnabled=true` is set
 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:
 
 ```kotlin
-apply from: "../node_modules/cbl-reactnative/android/build.gradle"
+apply from: "../node_modules/@couchbase/couchbase-lite-react-native/android/build.gradle"
 ```
 
 when completed the last two lines of the file should look something like this:
 
 ```kotlin
 apply plugin: "com.facebook.react.rootproject"
-apply from: "../node_modules/cbl-reactnative/android/build.gradle"
+apply from: "../node_modules/@couchbase/couchbase-lite-react-native/android/build.gradle"
 ```
 
 Now you can install the gradle dependencies and build the Android project:
@@ -85,7 +91,7 @@ npm run start
 
 For developers using Expo, you must make sure you have the dev-client installed in your app. Expo Go is not compatible with custom React Native Native Module.  To install the dev-client, review the [Expo documentation](https://docs.expo.dev/develop/development-builds/introduction/#what-is-expo-dev-client) along with the [Local App develompent documentation](https://docs.expo.dev/guides/local-app-development/).   These directions assume dev-client is setup and you can build locally your app on iOS and Android.
 
-The expo environment dynamically builds both the Cocoapod file for iOS and Gradle file for Android.  Because of this you will need to register the cbl-reactnative package with the expo environment via the Expo plugin api. 
+The expo environment dynamically builds both the Cocoapod file for iOS and Gradle file for Android.  Because of this you will need to register the @couchbase/couchbase-lite-react-native package with the expo environment via the Expo plugin api. 
 
 This can be done by creating a new file in the root of your project called `plugin.config.js` and adding the following code:
 
@@ -98,7 +104,7 @@ const {
 
 // Function to modify Android build.gradle
 function modifyAndroidBuildGradle(config) {
-  const lineToAdd = ` apply from: "../node_modules/cbl-reactnative/android/build.gradle"`;
+  const lineToAdd = ` apply from: "../node_modules/@couchbase/couchbase-lite-react-native/android/build.gradle"`;
   if (!config.modResults.contents.includes(lineToAdd)) {
     config.modResults.contents += `\n${lineToAdd}`;
     console.debug(config.modResults.contents);
@@ -117,7 +123,7 @@ function modifyXcodeProject(config) {
 // Function to modify Podfile properties to include the native module podspec
 function includeNativeModulePod(config) {
   return withPodfileProperties(config, async (podConfig) => {
-    const podspecPath = `../node_modules/cbl-reactnative/cbl-reactnative.podspec`;
+    const podspecPath = `../node_modules/@couchbase/couchbase-lite-react-native/cbl-reactnative.podspec`;
     if (podConfig.modResults.podfileProperties !== undefined && podConfig.modResults.podfileProperties.pod !== undefined) {
       podConfig.modResults.podfileProperties.pod(
           `'cbl-reactnative', :path => '${podspecPath}'`