xmartlabs · joaguirrem · Mar 4, 2026 · Feb 27, 2026 · Feb 27, 2026 · Mar 4, 2026
diff --git a/README.md b/README.md
@@ -3,33 +3,33 @@
 [![npm version](https://img.shields.io/npm/v/@xmartlabs/react-native-line.svg?style=flat-square)](https://www.npmjs.com/package/@xmartlabs/react-native-line)
 [![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
-Line SDK wrapper for React Native 🚀
+LINE SDK wrapper for React Native 🚀
 
 - [LINE SDK v5 for iOS](https://developers.line.biz/en/reference/ios-sdk-swift/), wrapped with [Swift](https://developer.apple.com/swift/).
 - [LINE SDK v5 for Android](https://developers.line.biz/en/reference/android-sdk/), wrapped with [Kotlin](https://kotlinlang.org/).
 
 ## Requirements
 
-- Android `minSdkVersion` needs to be at least version `24`.
-- iOS `deploymentTarget` needs to be at least version `15.1`.
-- [LINE developer account](https://developers.line.biz/console/) needs to be created and also a channel.
+- Android `minSdkVersion` must be `24` or higher.
+- iOS `deploymentTarget` must be `15.1` or higher.
+- A [LINE developer account](https://developers.line.biz/console/) and a configured channel are required.
 
 > [!IMPORTANT]
-> @xmartlabs/react-native-line v5 is now a TurboModule and **requires the new architecture to be enabled**.
-> - If you want to use @xmartlabs/react-native-line v5, you will need to enable the new architecture in your app (see how to [enable the new architecture for apps](https://github.com/reactwg/react-native-new-architecture/blob/main/docs/enable-apps.md)).
-> - If you cannot enable the new architecture yet, downgrade to @xmartlabs/react-native-line v4 for now.
+> `@xmartlabs/react-native-line` v6 is a TurboModule and **requires the new architecture to be enabled**.
+> - To use v6, enable the new architecture in your app (see [how to enable the new architecture](https://github.com/reactwg/react-native-new-architecture/blob/main/docs/enable-apps.md)).
+> - If you cannot enable the new architecture yet, use `@xmartlabs/react-native-line` v4 instead.
 
 ## Installation
 
 ### With Expo
 
-1. Install the JavaScript side with:
+1. Install the package:
 
     ```bash
     npx expo install @xmartlabs/react-native-line
     ```
 
-2. Add the plugins `expo-build-properties` and `@xmartlabs/react-native-line` to your `app.json`:
+2. Add the `expo-build-properties` and `@xmartlabs/react-native-line` plugins to your `app.json`:
 
     ```json
     "plugins": [
@@ -45,42 +45,25 @@ Line SDK wrapper for React Native 🚀
     ]
     ```
 
-### With react-native-cli
+### With React Native CLI
 
-1. Install library:
+1. Install the package:
 
     ```bash
     npm install @xmartlabs/react-native-line
-
-    # --- or ---
-
+    # or
     yarn add @xmartlabs/react-native-line
     ```
 
-2. Link iOS native code:
+2. Install the iOS native dependencies:
 
     ```bash
     cd ios && pod install
     ```
 
-3. Change your `AppDelegate` to match the following:
-
-    #### With Objective-C
+3. Update your `AppDelegate` to forward URL callbacks to the LINE SDK:
 
-    ##### @xmartlabs/react-native-line v4
-
-    ```objectivec
-    #import "RNLine-Swift.h"
-
-    ...
-
-    - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
-    {
-      return [LineLogin application:application open:url options:options];
-    }
-    ```
-
-    ##### @xmartlabs/react-native-line v5
+    #### Objective-C
 
     ```objectivec
     #import "react_native_line-Swift.h"
@@ -93,21 +76,7 @@ Line SDK wrapper for React Native 🚀
     }
     ```
 
-    #### With Swift
-
-    ##### @xmartlabs/react-native-line v4
-
-    ```swift
-    import RNLine
-
-    ...
-
-    override func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
-      return LineLogin.application(application, open: url, options: options)
-    }
-    ```
-
-    ##### @xmartlabs/react-native-line v5
+    #### Swift
 
     ```swift
     import react_native_line
@@ -119,7 +88,7 @@ Line SDK wrapper for React Native 🚀
     }
     ```
 
-4. Insert the following [snippet](https://developers.line.biz/en/docs/line-login-sdks/ios-sdk/swift/setting-up-project/#config-infoplist-file) in your `Info.plist` just before the last `</dict>` tag:
+4. Add the following entries to your `Info.plist` just before the closing `</dict>` tag ([reference](https://developers.line.biz/en/docs/line-login-sdks/ios-sdk/swift/setting-up-project/#config-infoplist-file)):
 
     ```xml
     <key>CFBundleURLTypes</key>
@@ -139,19 +108,19 @@ Line SDK wrapper for React Native 🚀
     </array>
     ```
 
-## Migration guide
+## Migration Guide
 
-You can find the migration guide in the [linked document](./docs/MIGRATION_GUIDE.md).
+See the [Migration Guide](./docs/MIGRATION_GUIDE.md) for upgrade instructions between versions.
 
 ## Usage
 
-1. Import the `Line` module:
+1. Import the module and any enums you need:
 
     ```typescript
-    import Line from '@xmartlabs/react-native-line'
+    import Line, { Scope, BotPrompt } from '@xmartlabs/react-native-line'
     ```
 
-2. Initialize the module with the `setup` method:
+2. Initialize the SDK with the `setup` method. Call this once when your app starts:
 
     ```typescript
     useEffect(() => {
@@ -162,29 +131,111 @@ You can find the migration guide in the [linked document](./docs/MIGRATION_GUIDE
 3. Log in with the `login` method:
 
     ```typescript
+    // Default login — requests the profile scope only
     Line.login({})
+
+    // Explicit scopes and bot prompt
+    Line.login({
+      scopes: [Scope.Profile, Scope.OpenId],
+      botPrompt: BotPrompt.Normal,
+    })
     ```
 
 ## API
 
-| Method                                                 | Description                                                                                                                                                                                                                        |
-| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `login(params: LoginParams): Promise<LoginResult>` | Starts the login flow of Line's SDK (Opens the apps if it's installed and defaults to the browser otherwise). It accepts the same argumements as the LineSDK, in an object `{ key: value }`, defaults the same way as LineSDK too. |
-| `getCurrentAccessToken(): Promise<AccessToken>` | Returns the access token of the current user. |
-| `getProfile(): Promise<UserProfile>` | Returns the current user profile information. |
-| `logout(): Promise<void>` | Revokes the access token of the current user. |
-| `refreshAccessToken(): Promise<AccessToken>` | Refreshes the access token of the current user. |
-| `setup(params: SetupParams): Promise<void>` | Initializes the Line SDK. |
-| `verifyAccessToken(): Promise<VerifyResult>` | Checks whether the access token of the current user is valid. |
-| `getFriendshipStatus(): Promise<FriendshipStatus>` | Gets the friendship status between the LINE Official Account (which is linked to the current channel) and the user if [configured](https://developers.line.biz/en/docs/line-login-sdks/ios-sdk/swift/link-a-bot/). |
+### Methods
+
+| Method | Description |
+| --- | --- |
+| `setup(params: SetupParams): Promise<void>` | Initializes the LINE SDK. Must be called before any other method. |
+| `login(params: LoginParams): Promise<LoginResult>` | Starts the LINE login flow. Opens the LINE app if installed, otherwise falls back to the browser. |
+| `logout(): Promise<void>` | Revokes the current user's access token and clears the local session. |
+| `getCurrentAccessToken(): Promise<AccessToken>` | Returns the locally cached access token for the current user, without a network call. |
+| `refreshAccessToken(): Promise<AccessToken>` | Exchanges the current access token for a fresh one. |
+| `verifyAccessToken(): Promise<VerifyResult>` | Validates the current access token against the LINE server and returns its metadata. |
+| `getProfile(): Promise<UserProfile>` | Returns the current user's LINE profile. Requires `Scope.Profile`. |
+| `getFriendshipStatus(): Promise<FriendshipStatus>` | Returns whether the current user has added the channel's linked LINE Official Account as a friend. Requires [bot linkage](https://developers.line.biz/en/docs/line-login/link-a-bot/) to be configured. |
+
+### Types
+
+#### `SetupParams`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `channelId` | `string` | Your LINE Login channel ID. |
+| `universalLinkUrl` | `string?` | Universal link URL registered for your channel. iOS only. |
+
+#### `LoginParams`
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `scopes` | `Scope[]` | `[Scope.Profile]` | OAuth scopes to request. |
+| `onlyWebLogin` | `boolean` | `false` | Skip the LINE app and use the browser-based login flow. |
+| `botPrompt` | `BotPrompt` | `BotPrompt.Normal` | Controls the bot friend-add prompt shown during login. |
+
+#### `Scope` (enum)
+
+| Value | String | Description |
+| --- | --- | --- |
+| `Scope.Profile` | `'profile'` | Access to the user's display name, picture URL, status message, and user ID. |
+| `Scope.OpenId` | `'openid'` | Issues an OpenID Connect ID token. Required to receive `idToken`. |
+| `Scope.Email` | `'email'` | Access to the user's email address. Requires channel approval from LINE. |
+
+#### `BotPrompt` (enum)
+
+| Value | Description |
+| --- | --- |
+| `BotPrompt.Normal` | Adds an inline "Add friend" option in the consent screen. |
+| `BotPrompt.Aggressive` | Shows a standalone friend-add screen after the consent screen. |
+
+#### `AccessToken`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `accessToken` | `string` | Bearer token used to authorize LINE API calls. |
+| `expiresIn` | `number` | Seconds until the token expires (OAuth standard `expires_in`). |
+| `idToken` | `string?` | Raw OpenID Connect ID token. Present only when `Scope.OpenId` was requested. |
+
+#### `LoginResult`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `accessToken` | `AccessToken` | The access token issued for this login session. |
+| `scope` | `string` | Space-separated list of granted scopes (e.g. `"profile openid"`). |
+| `userProfile` | `UserProfile?` | The user's profile. Present only when `Scope.Profile` was requested. |
+| `friendshipStatusChanged` | `boolean?` | Whether the user's friendship status with the linked LINE Official Account changed during this login. |
+| `idTokenNonce` | `string?` | Nonce for ID token verification. Present only when `Scope.OpenId` was requested. |
+
+#### `UserProfile`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `userId` | `string` | The user's LINE user ID. Stable across logins for the same channel. |
+| `displayName` | `string` | The user's LINE display name. |
+| `pictureUrl` | `string?` | URL of the user's profile picture. |
+| `statusMessage` | `string?` | The user's LINE status message. |
+
+#### `FriendshipStatus`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `friendFlag` | `boolean` | `true` if the user has added the linked LINE Official Account as a friend. |
+
+#### `VerifyResult`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `clientId` | `string` | The channel ID the access token was issued for. |
+| `expiresIn` | `number` | Seconds until the token expires. |
+| `scope` | `string` | Space-separated list of scopes granted to the token. |
 
 ## Example
 
-If you want to see `@xmartlabs/react-native-line` in action, just move into the [example](/example) folder and run `npm install` and then `npm run ios`/`npm run android`. By seeing its source code, you will have a better understanding of the library usage.
+Check the [example app](/example) for a complete working implementation. To run it locally, navigate to the [example](/example) folder and run `npm install`, then `npm run ios` or `npm run android`.
 
 ## License
 
-`@xmartlabs/react-native-line` is available under the MIT license. See the LICENCE file for more info.
+`@xmartlabs/react-native-line` is available under the MIT license. See the [LICENSE](./LICENSE) file for details.
 
 <p align="center">
   <img src="https://github.com/user-attachments/assets/53fab07a-54f5-4f46-a894-e3476318a68d" alt="Xmartlabs Logo" width="150" />

diff --git a/android/src/main/java/com/xmartlabs/line/LineLoginModule.kt b/android/src/main/java/com/xmartlabs/line/LineLoginModule.kt
@@ -286,7 +286,7 @@ class LineLoginModule(reactContext: ReactApplicationContext) :
     private fun buildVerifyResult(credential: LineCredential): WritableMap =
         Arguments.makeNativeMap(
             mapOf(
-                "clientId"  to channelId,
+                "channelId"  to channelId,
                 "expiresIn" to credential.accessToken.expiresInMillis / 1000L,
                 "scope"     to Scope.join(credential.scopes),
             )