@robylon/react-native-sdk 2.2.1-staging.1 → 2.2.1

package/README.md

@@ -11,6 +11,7 @@
   - [Required Props](#required-props)
   - [Optional Props](#optional-props)
   - [User Profile Properties](#user-profile-properties)
+  - [Loading Screen](#loading-screen)
 - [External Trigger API](#external-trigger-api)
   - [Ref-based Imperative API](#ref-based-imperative-api)
   - [Ref Methods](#ref-methods)
@@ -54,6 +55,7 @@ import {
   Chatbot, // Main chatbot component
   ChatbotRef, // Ref interface for imperative control
   ChatbotProps, // Props interface
+  ChatbotLoadingScreen, // Shape of the `loading_screen` prop
   ChatbotEventType, // Event types enum
   ChatbotEventHandler, // Event handler type
 } from "@robylon/react-native-sdk";
@@ -115,6 +117,7 @@ export default App;
 | `session_id`      | string                                                                                               | Session to resume. Read when the chat initializes — see [Session Management](#session-management) |
 | `session_context` | Record<string, any>                                                                                  | Opaque value echoed back as the second argument to `onSession`. Never read by the SDK |
 | `discrete`        | boolean                                                                                              | Defaults to `false`. When `true`, signals to Robylon that this chatbot should be treated as discrete. Read at initialization |
+| `loading_screen`  | ChatbotLoadingScreen                                                                                 | Branding shown while the chat UI boots — see [Loading Screen](#loading-screen) |
 | `onSession`    | (session_id: string, session_context?: Record<string, any>) => void                                     | Called whenever the active session id changes                                      |
 | `onEvent`      | ChatbotEventHandler                                                                                     | Callback for chatbot events                                                        |
 | `onOpen`       | () => void                                                                                              | Callback when chatbot opens                                                        |
@@ -130,6 +133,60 @@ The `user_profile` object can include:
 - `mobile`: User's mobile number (optional)
 - `is_test_user`: Mark user as test user for development/testing purposes (optional)
 
+### Loading Screen
+
+> **Requires SDK ≥ 2.2.1**
+
+The chat UI fetches its own configuration when it boots. Until that call
+returns it has nothing to render a header with, so it shows a skeleton and then
+snaps to your branding — a visible flash every time the chat opens.
+
+The SDK already holds that branding: it fetches your configuration before it
+mounts the chat, to decide whether to render a launcher and what it should look
+like. It now passes a few of those fields to the chat UI so the real header can
+paint immediately.
+
+**This happens automatically — no props required.** The values come from your
+Robylon dashboard configuration. Use `loading_screen` only when you want to
+override them for a particular integration:
+
+```typescript
+<Chatbot
+  api_key="YOUR_API_KEY"
+  loading_screen={{
+    image: "https://example.com/header-avatar.png",
+    bot_name: "Acme Support",
+    brand_color: "#5B3DF5",
+    powered_by: false,
+    sub_text: "Typically replies in a minute",
+  }}
+/>
+```
+
+| Field         | Type    | Description                                                          |
+| ------------- | ------- | -------------------------------------------------------------------- |
+| `image`       | string  | Header avatar. Defaults to your header image, then your brand logo    |
+| `bot_name`    | string  | Display name in the header                                            |
+| `brand_color` | string  | Colour the header is tinted with                                      |
+| `powered_by`  | boolean | Whether the "powered by" footer shows                                 |
+| `sub_text`    | string  | Sub-text under the header. No dashboard equivalent — prop only      |
+
+#### Behaviour
+
+- **Every field is optional.** Anything you omit falls back to your dashboard
+  configuration, field by field. Passing `{ bot_name: "Acme" }` overrides only
+  the name; the image, colour and footer still come from your dashboard.
+- **Explicit values always win**, including falsy ones. `powered_by: false`
+  overrides a dashboard setting of `true`.
+- **`sub_text` has no dashboard equivalent**, so it appears only when you pass
+  it here.
+- **First paint only.** These are sent once, when the chat surface first loads,
+  and are not re-sent when the user reopens the chat — by then the chat UI has
+  its own configuration. They do not restyle the running chat.
+- **A hint, not a source of truth.** The chat UI reconciles to its own
+  configuration once that call lands, so a value that is missing or out of date
+  is corrected rather than sticking.
+
 ## External Trigger API
 
 The SDK now supports external triggering of the chatbot through both controlled component patterns and imperative ref methods.

package/lib/commonjs/config.js

@@ -1,2 +1,2 @@
-Object.defineProperty(exports,"__esModule",{value:true});exports.config=void 0;var config=exports.config={API_URL:process&&process.env&&process.env.API_URL||"https://stage-api.robylon.ai"||'https://api.robylon.com',DEBUG:(process&&process.env&&process.env.DEBUG||"true")==='true'};
+Object.defineProperty(exports,"__esModule",{value:true});exports.config=void 0;var config=exports.config={API_URL:process&&process.env&&process.env.API_URL||"https://api.robylon.ai"||'https://api.robylon.com',DEBUG:(process&&process.env&&process.env.DEBUG||"false")==='true'};
 //# sourceMappingURL=config.js.map

package/lib/commonjs/config.js.map

@@ -1 +1 @@
-{"version":3,"names":["config","exports","API_URL","process","env","process.env","DEBUG"],"sourceRoot":"../../src","sources":["config.ts"],"mappings":"+EAAO,GAAM,CAAAA,MAAM,CAAAC,OAAA,CAAAD,MAAA,CAAG,CACpBE,OAAO,CAAEC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAH,OAAA,kCAAuB,yBAAyB,CACzDI,KAAK,CAAE,CAAAH,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,KAAA,YAAsB,MAC/B,CAAC","ignoreList":[]}
+{"version":3,"names":["config","exports","API_URL","process","env","process.env","DEBUG"],"sourceRoot":"../../src","sources":["config.ts"],"mappings":"+EAAO,GAAM,CAAAA,MAAM,CAAAC,OAAA,CAAAD,MAAA,CAAG,CACpBE,OAAO,CAAEC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAH,OAAA,4BAAuB,yBAAyB,CACzDI,KAAK,CAAE,CAAAH,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,KAAA,aAAsB,MAC/B,CAAC","ignoreList":[]}

package/lib/commonjs/constants.js

@@ -1,2 +1,2 @@
-Object.defineProperty(exports,"__esModule",{value:true});exports.DEFAULT_LAUNCHER_IMAGE=exports.BASE_CHATBOT_URL=exports.API_URL=void 0;var BASE_CHATBOT_DOMAIN=process&&process.env&&process.env.CHATBOT_DOMAIN||"https://staging.d2s3wsqyyond1h.amplifyapp.com"||"";var CHATBOT_PATH=process&&process.env&&process.env.CHATBOT_PATH||"chatbot-plugin"||"";var BASE_CHATBOT_URL=exports.BASE_CHATBOT_URL=`${BASE_CHATBOT_DOMAIN}/${CHATBOT_PATH}`;var API_URL=exports.API_URL=process&&process.env&&process.env.API_URL||"https://stage-api.robylon.ai";var DEFAULT_LAUNCHER_IMAGE=exports.DEFAULT_LAUNCHER_IMAGE=`${BASE_CHATBOT_DOMAIN}/chatbubble.png`;
+Object.defineProperty(exports,"__esModule",{value:true});exports.DEFAULT_LAUNCHER_IMAGE=exports.BASE_CHATBOT_URL=exports.API_URL=void 0;var BASE_CHATBOT_DOMAIN=process&&process.env&&process.env.CHATBOT_DOMAIN||"https://chatbot.robylon.ai"||"";var CHATBOT_PATH=process&&process.env&&process.env.CHATBOT_PATH||"chatbot-plugin"||"";var BASE_CHATBOT_URL=exports.BASE_CHATBOT_URL=`${BASE_CHATBOT_DOMAIN}/${CHATBOT_PATH}`;var API_URL=exports.API_URL=process&&process.env&&process.env.API_URL||"https://api.robylon.ai";var DEFAULT_LAUNCHER_IMAGE=exports.DEFAULT_LAUNCHER_IMAGE=`${BASE_CHATBOT_DOMAIN}/chatbubble.png`;
 //# sourceMappingURL=constants.js.map

package/lib/commonjs/constants.js.map

@@ -1 +1 @@
-{"version":3,"names":["BASE_CHATBOT_DOMAIN","process","env","process.env","CHATBOT_DOMAIN","CHATBOT_PATH","BASE_CHATBOT_URL","exports","API_URL","DEFAULT_LAUNCHER_IMAGE"],"sourceRoot":"../../src","sources":["constants.ts"],"mappings":"wIAAA,GAAM,CAAAA,mBAAmB,CAAGC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,cAAA,mDAA8B,EAAE,CAC5D,GAAM,CAAAC,YAAY,CAAGJ,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAE,YAAA,oBAA4B,EAAE,CAC5C,GAAM,CAAAC,gBAAgB,CAAAC,OAAA,CAAAD,gBAAA,CAAG,GAAGN,mBAAmB,IAAIK,YAAY,EAAE,CACjE,GAAM,CAAAG,OAAO,CAAAD,OAAA,CAAAC,OAAA,CAAAP,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAK,OAAA,gCAAsB,CACnC,GAAM,CAAAC,sBAAsB,CAAAF,OAAA,CAAAE,sBAAA,CAAG,GAAGT,mBAAmB,iBAAiB","ignoreList":[]}
+{"version":3,"names":["BASE_CHATBOT_DOMAIN","process","env","process.env","CHATBOT_DOMAIN","CHATBOT_PATH","BASE_CHATBOT_URL","exports","API_URL","DEFAULT_LAUNCHER_IMAGE"],"sourceRoot":"../../src","sources":["constants.ts"],"mappings":"wIAAA,GAAM,CAAAA,mBAAmB,CAAGC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,cAAA,gCAA8B,EAAE,CAC5D,GAAM,CAAAC,YAAY,CAAGJ,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAE,YAAA,oBAA4B,EAAE,CAC5C,GAAM,CAAAC,gBAAgB,CAAAC,OAAA,CAAAD,gBAAA,CAAG,GAAGN,mBAAmB,IAAIK,YAAY,EAAE,CACjE,GAAM,CAAAG,OAAO,CAAAD,OAAA,CAAAC,OAAA,CAAAP,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAK,OAAA,0BAAsB,CACnC,GAAM,CAAAC,sBAAsB,CAAAF,OAAA,CAAAE,sBAAA,CAAG,GAAGT,mBAAmB,iBAAiB","ignoreList":[]}

package/lib/module/config.js

@@ -1,2 +1,2 @@
-Object.defineProperty(exports,"__esModule",{value:true});exports.config=void 0;var config=exports.config={API_URL:process&&process.env&&process.env.API_URL||"https://stage-api.robylon.ai"||'https://api.robylon.com',DEBUG:(process&&process.env&&process.env.DEBUG||"true")==='true'};
+Object.defineProperty(exports,"__esModule",{value:true});exports.config=void 0;var config=exports.config={API_URL:process&&process.env&&process.env.API_URL||"https://api.robylon.ai"||'https://api.robylon.com',DEBUG:(process&&process.env&&process.env.DEBUG||"false")==='true'};
 //# sourceMappingURL=config.js.map

package/lib/module/config.js.map

@@ -1 +1 @@
-{"version":3,"names":["config","exports","API_URL","process","env","process.env","DEBUG"],"sourceRoot":"../../src","sources":["config.ts"],"mappings":"+EAAO,GAAM,CAAAA,MAAM,CAAAC,OAAA,CAAAD,MAAA,CAAG,CACpBE,OAAO,CAAEC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAH,OAAA,kCAAuB,yBAAyB,CACzDI,KAAK,CAAE,CAAAH,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,KAAA,YAAsB,MAC/B,CAAC","ignoreList":[]}
+{"version":3,"names":["config","exports","API_URL","process","env","process.env","DEBUG"],"sourceRoot":"../../src","sources":["config.ts"],"mappings":"+EAAO,GAAM,CAAAA,MAAM,CAAAC,OAAA,CAAAD,MAAA,CAAG,CACpBE,OAAO,CAAEC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAH,OAAA,4BAAuB,yBAAyB,CACzDI,KAAK,CAAE,CAAAH,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,KAAA,aAAsB,MAC/B,CAAC","ignoreList":[]}

package/lib/module/constants.js

@@ -1,2 +1,2 @@
-Object.defineProperty(exports,"__esModule",{value:true});exports.DEFAULT_LAUNCHER_IMAGE=exports.BASE_CHATBOT_URL=exports.API_URL=void 0;var BASE_CHATBOT_DOMAIN=process&&process.env&&process.env.CHATBOT_DOMAIN||"https://staging.d2s3wsqyyond1h.amplifyapp.com"||"";var CHATBOT_PATH=process&&process.env&&process.env.CHATBOT_PATH||"chatbot-plugin"||"";var BASE_CHATBOT_URL=exports.BASE_CHATBOT_URL=`${BASE_CHATBOT_DOMAIN}/${CHATBOT_PATH}`;var API_URL=exports.API_URL=process&&process.env&&process.env.API_URL||"https://stage-api.robylon.ai";var DEFAULT_LAUNCHER_IMAGE=exports.DEFAULT_LAUNCHER_IMAGE=`${BASE_CHATBOT_DOMAIN}/chatbubble.png`;
+Object.defineProperty(exports,"__esModule",{value:true});exports.DEFAULT_LAUNCHER_IMAGE=exports.BASE_CHATBOT_URL=exports.API_URL=void 0;var BASE_CHATBOT_DOMAIN=process&&process.env&&process.env.CHATBOT_DOMAIN||"https://chatbot.robylon.ai"||"";var CHATBOT_PATH=process&&process.env&&process.env.CHATBOT_PATH||"chatbot-plugin"||"";var BASE_CHATBOT_URL=exports.BASE_CHATBOT_URL=`${BASE_CHATBOT_DOMAIN}/${CHATBOT_PATH}`;var API_URL=exports.API_URL=process&&process.env&&process.env.API_URL||"https://api.robylon.ai";var DEFAULT_LAUNCHER_IMAGE=exports.DEFAULT_LAUNCHER_IMAGE=`${BASE_CHATBOT_DOMAIN}/chatbubble.png`;
 //# sourceMappingURL=constants.js.map

package/lib/module/constants.js.map

@@ -1 +1 @@
-{"version":3,"names":["BASE_CHATBOT_DOMAIN","process","env","process.env","CHATBOT_DOMAIN","CHATBOT_PATH","BASE_CHATBOT_URL","exports","API_URL","DEFAULT_LAUNCHER_IMAGE"],"sourceRoot":"../../src","sources":["constants.ts"],"mappings":"wIAAA,GAAM,CAAAA,mBAAmB,CAAGC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,cAAA,mDAA8B,EAAE,CAC5D,GAAM,CAAAC,YAAY,CAAGJ,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAE,YAAA,oBAA4B,EAAE,CAC5C,GAAM,CAAAC,gBAAgB,CAAAC,OAAA,CAAAD,gBAAA,CAAG,GAAGN,mBAAmB,IAAIK,YAAY,EAAE,CACjE,GAAM,CAAAG,OAAO,CAAAD,OAAA,CAAAC,OAAA,CAAAP,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAK,OAAA,gCAAsB,CACnC,GAAM,CAAAC,sBAAsB,CAAAF,OAAA,CAAAE,sBAAA,CAAG,GAAGT,mBAAmB,iBAAiB","ignoreList":[]}
+{"version":3,"names":["BASE_CHATBOT_DOMAIN","process","env","process.env","CHATBOT_DOMAIN","CHATBOT_PATH","BASE_CHATBOT_URL","exports","API_URL","DEFAULT_LAUNCHER_IMAGE"],"sourceRoot":"../../src","sources":["constants.ts"],"mappings":"wIAAA,GAAM,CAAAA,mBAAmB,CAAGC,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAC,cAAA,gCAA8B,EAAE,CAC5D,GAAM,CAAAC,YAAY,CAAGJ,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAE,YAAA,oBAA4B,EAAE,CAC5C,GAAM,CAAAC,gBAAgB,CAAAC,OAAA,CAAAD,gBAAA,CAAG,GAAGN,mBAAmB,IAAIK,YAAY,EAAE,CACjE,GAAM,CAAAG,OAAO,CAAAD,OAAA,CAAAC,OAAA,CAAAP,OAAA,EAAAA,OAAA,CAAAC,GAAA,EAAAC,WAAA,CAAAK,OAAA,0BAAsB,CACnC,GAAM,CAAAC,sBAAsB,CAAAF,OAAA,CAAAE,sBAAA,CAAG,GAAGT,mBAAmB,iBAAiB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robylon/react-native-sdk",
-  "version": "2.2.1-staging.1",
+  "version": "2.2.1",
   "description": "React Native SDK for Robylon",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",

package/android/src/main/AndroidManifest.xml

@@ -1,3 +0,0 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-  package="com.robylonreactnativesdk">
-</manifest>

package/android/src/main/java/com/robylonreactnativesdk/RobylonDownloadModule.java

@@ -1,83 +0,0 @@
-package com.robylonreactnativesdk;
-
-import android.app.DownloadManager;
-import android.content.Context;
-import android.net.Uri;
-import android.os.Environment;
-import android.webkit.MimeTypeMap;
-
-import androidx.annotation.NonNull;
-
-import com.facebook.react.bridge.Promise;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
-import com.facebook.react.bridge.ReactMethod;
-
-public class RobylonDownloadModule extends ReactContextBaseJavaModule {
-  private final ReactApplicationContext reactContext;
-
-  public RobylonDownloadModule(ReactApplicationContext reactContext) {
-    super(reactContext);
-    this.reactContext = reactContext;
-  }
-
-  @NonNull
-  @Override
-  public String getName() {
-    return "RobylonDownloadModule";
-  }
-
-  @ReactMethod
-  public void downloadFile(String url, String filename, Promise promise) {
-    try {
-      if (url == null || url.trim().isEmpty()) {
-        promise.reject("INVALID_URL", "Download URL is missing");
-        return;
-      }
-
-      String safeName = getSafeFileName(filename, url);
-      DownloadManager manager = (DownloadManager) reactContext.getSystemService(Context.DOWNLOAD_SERVICE);
-      if (manager == null) {
-        promise.reject("DOWNLOAD_SERVICE_UNAVAILABLE", "Download service unavailable");
-        return;
-      }
-
-      DownloadManager.Request request = new DownloadManager.Request(Uri.parse(url));
-      request.setTitle(safeName);
-      request.setDescription("Downloading transcript");
-      request.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
-      request.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, safeName);
-      request.setMimeType(getMimeTypeFromName(safeName));
-      request.setAllowedOverMetered(true);
-      request.setAllowedOverRoaming(true);
-
-      long downloadId = manager.enqueue(request);
-      promise.resolve(String.valueOf(downloadId));
-    } catch (Exception error) {
-      promise.reject("DOWNLOAD_FAILED", error);
-    }
-  }
-
-  private String getSafeFileName(String filename, String url) {
-    if (filename != null && !filename.trim().isEmpty()) {
-      return filename.trim().replaceAll("[\\\\/:*?\"<>|]", "_");
-    }
-    String fromUrl = Uri.parse(url).getLastPathSegment();
-    if (fromUrl == null || fromUrl.trim().isEmpty()) {
-      return "chat-transcript-" + System.currentTimeMillis() + ".txt";
-    }
-    return fromUrl.trim().replaceAll("[\\\\/:*?\"<>|]", "_");
-  }
-
-  private String getMimeTypeFromName(String filename) {
-    String extension = MimeTypeMap.getFileExtensionFromUrl(filename);
-    if (extension == null || extension.isEmpty()) {
-      return "application/octet-stream";
-    }
-    String mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(extension.toLowerCase());
-    if (mimeType == null || mimeType.isEmpty()) {
-      return "application/octet-stream";
-    }
-    return mimeType;
-  }
-}

package/android/src/main/java/com/robylonreactnativesdk/RobylonReactNativeSdkPackage.java

@@ -1,24 +0,0 @@
-package com.robylonreactnativesdk;
-
-import com.facebook.react.ReactPackage;
-import com.facebook.react.bridge.NativeModule;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.uimanager.ViewManager;
-
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-
-public class RobylonReactNativeSdkPackage implements ReactPackage {
-  @Override
-  public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
-    List<NativeModule> modules = new ArrayList<>();
-    modules.add(new RobylonDownloadModule(reactContext));
-    return modules;
-  }
-
-  @Override
-  public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
-    return Collections.emptyList();
-  }
-}