@usechatting/react-native 0.1.0 → 0.1.1

package/README.md

@@ -1,14 +1,6 @@
 # @usechatting/react-native
 
-Expo-friendly React Native chat package for Chatting.
-
-## What it includes
-
-- JavaScript client for Chatting public chat APIs
-- pluggable async session storage
-- React hook for conversation state
-- simple React Native chat screen
-- live conversation sync with automatic polling fallback
+Add Chatting customer support to an Expo or React Native app.
 
 ## Install
 
@@ -16,107 +8,46 @@ Expo-friendly React Native chat package for Chatting.
 npm install @usechatting/react-native
 ```
 
-If you want session persistence across app restarts, also install an async storage adapter in your app, for example React Native Async Storage.
-
-For Expo push notifications in your host app, also install:
-
-```bash
-npx expo install expo-notifications
-```
-
-## Required config
+## Get your site ID
 
-- `baseURL`: use `https://usechatting.com`
-- `siteId`: your site/workspace ID inside Chatting
+Open [Widget → Installation](https://usechatting.com/dashboard/widget?tab=installation) in Chatting and copy the `data-site-id` value.
 
-## Exact Expo integration snippet
+## Add the support screen
 
 ```tsx
-import { useEffect, useMemo, useState } from "react";
-import AsyncStorage from "@react-native-async-storage/async-storage";
-import * as Notifications from "expo-notifications";
-import { AppState, Platform } from "react-native";
 import {
   ChattingClient,
-  ChattingConversationScreen,
-  createKeyValueSessionStore
+  ChattingConversationScreen
 } from "@usechatting/react-native";
 
-Notifications.setNotificationHandler({
-  handleNotification: async () => ({
-    shouldShowAlert: false,
-    shouldPlaySound: false,
-    shouldSetBadge: false
-  })
-});
-
 const client = new ChattingClient({
-  baseURL: "https://usechatting.com",
-  siteId: "your-site-id",
-  sessionStore: createKeyValueSessionStore(AsyncStorage, "your-site-id")
+  siteId: "your-site-id"
 });
 
 export function SupportScreen() {
-  const [refreshKey, setRefreshKey] = useState(0);
-  const context = useMemo(() => ({ pageUrl: "myapp://support" }), []);
-
-  useEffect(() => {
-    let mounted = true;
-    const refreshChat = async () => {
-      await client.syncPushToken();
-      if (mounted) {
-        setRefreshKey((current) => current + 1);
-      }
-    };
-
-    const registerPush = async () => {
-      const permission = await Notifications.requestPermissionsAsync();
-      if (!mounted || permission.status !== "granted") {
-        return;
-      }
-
-      const token = await Notifications.getExpoPushTokenAsync({
-        projectId: "your-expo-project-id"
-      });
-
-      await client.registerPushToken({
-        pushToken: token.data,
-        platform: Platform.OS
-      });
-    };
-
-    void registerPush();
-
-    const appStateSubscription = AppState.addEventListener("change", (nextState) => {
-      if (nextState === "active") {
-        void refreshChat();
-      }
-    });
-
-    const responseSubscription = Notifications.addNotificationResponseReceivedListener(() => {
-      void refreshChat();
-    });
-
-    return () => {
-      mounted = false;
-      appStateSubscription.remove();
-      responseSubscription.remove();
-    };
-  }, []);
-
-  return (
-    <ChattingConversationScreen
-      key={refreshKey}
-      client={client}
-      context={context}
-      draftVisitorEmail="customer@example.com"
-    />
-  );
+  return <ChattingConversationScreen client={client} />;
 }
 ```
 
-## Realtime behavior
+Messages sent here appear in your Chatting inbox. Team replies appear in the app while the screen is open.
+
+## Keep conversations after the app closes
+
+Add `persistSession: true` so customers can reopen the same conversation later:
+
+```tsx
+import { ChattingClient } from "@usechatting/react-native";
+
+const client = new ChattingClient({
+  siteId: "your-site-id",
+  persistSession: true
+});
+```
+
+## Optional features
 
-This package uses a dedicated React Native live transport for Chatting's SSE conversation stream, so new team messages and team typing updates show up immediately while the app is open. If that live connection drops, the hook falls back to foreground polling so the conversation stays usable while reconnecting.
+- Pass a signed-in customer to the screen with `profile={signedInCustomer}`.
+- Register an Expo push token if customers should receive phone notifications when your team replies and the app is not open.
+- Use `useChattingConversation` instead of the ready-made screen if you want to build your own interface.
 
-Expo push delivery is now supported for background and suspended apps once the host app registers an Expo push token through `client.registerPushToken(...)`. When the app becomes active again or a notification is tapped, call `client.syncPushToken()` and remount or refresh your chat screen so the conversation refetches cleanly.
+See the [complete setup guide](https://usechatting.com/guides/chatting-react-native-expo-guide).

package/dist/chatting-client.d.ts

@@ -1,4 +1,4 @@
-import type { ChattingClientOptions, ChattingConversationState, ChattingLiveEvent, ChattingPushRegistrationInput, ChattingSendMessageResult, ChattingSessionState, ChattingSiteConfig, ChattingSiteStatus, ChattingVisitorContext, ChattingVisitorProfile } from "./chatting-types";
+import type { ChattingClientOptions, ChattingConversationState, ChattingLiveEvent, ChattingPushRegistrationInput, ChattingSendMessageResult, ChattingSessionState, ChattingSiteStatus, ChattingVisitorContext, ChattingVisitorProfile } from "./chatting-types";
 export declare class ChattingClient {
     readonly siteId: string;
     private readonly sessionStore;
@@ -7,7 +7,7 @@ export declare class ChattingClient {
     currentSessionState(): Promise<ChattingSessionState>;
     clearConversation(): Promise<void>;
     saveEmail(email: string): Promise<void>;
-    fetchSiteConfig(context?: ChattingVisitorContext): Promise<ChattingSiteConfig>;
+    fetchSiteConfig(context?: ChattingVisitorContext): Promise<import("./chatting-types").ChattingSiteConfig>;
     fetchSiteStatus(context?: ChattingVisitorContext): Promise<ChattingSiteStatus>;
     fetchConversationIfAvailable(): Promise<ChattingConversationState | null>;
     fetchConversation(): Promise<ChattingConversationState>;

package/dist/chatting-client.js

@@ -1,4 +1,5 @@
-import { createMemorySessionStore } from "./chatting-session-store";
+import { resolveChattingSessionStore } from "./chatting-session-store";
+import { fetchChattingSiteConfig } from "./chatting-sdk-presence";
 import { buildChattingSiteQuery, DEFAULT_CHATTING_BASE_URL, requireChattingText } from "./chatting-client-shared";
 import { clearConversationPushState, registerChattingPushToken, syncChattingPushToken, unregisterChattingPushToken } from "./chatting-push-registration";
 import { ChattingTransport } from "./chatting-transport";
@@ -9,7 +10,7 @@ export class ChattingClient {
     transport;
     constructor(options) {
         this.siteId = options.siteId;
-        this.sessionStore = options.sessionStore ?? createMemorySessionStore();
+        this.sessionStore = resolveChattingSessionStore(options);
         this.transport = new ChattingTransport(options.baseURL ?? DEFAULT_CHATTING_BASE_URL, options.fetchImpl ?? fetch);
     }
     async currentSessionState() {
@@ -42,11 +43,12 @@ export class ChattingClient {
     }
     async fetchSiteConfig(context = {}) {
         const state = await this.currentSessionState();
-        const response = await this.transport.get("/api/public/site-config", {
-            ...buildChattingSiteQuery(this.siteId, state, resolveContext(context)),
-            conversationId: state.conversationId ?? null
+        return fetchChattingSiteConfig({
+            transport: this.transport,
+            siteId: this.siteId,
+            state,
+            context: resolveContext(context)
         });
-        return response.site;
     }
     async fetchSiteStatus(context = {}) {
         const state = await this.currentSessionState();

package/dist/chatting-sdk-presence.d.ts

@@ -0,0 +1,9 @@
+import { ChattingTransport } from "./chatting-transport";
+import type { ChattingSessionState, ChattingSiteConfig } from "./chatting-types";
+import type { resolveContext } from "./chatting-utils";
+export declare function fetchChattingSiteConfig(input: {
+    transport: ChattingTransport;
+    siteId: string;
+    state: ChattingSessionState;
+    context: ReturnType<typeof resolveContext>;
+}): Promise<ChattingSiteConfig>;

package/dist/chatting-sdk-presence.js

@@ -0,0 +1,10 @@
+import { buildChattingSiteQuery } from "./chatting-client-shared";
+export async function fetchChattingSiteConfig(input) {
+    const request = buildChattingSiteQuery(input.siteId, input.state, input.context);
+    await input.transport.post("/api/public/sdk-presence", request).catch(() => undefined);
+    const response = await input.transport.get("/api/public/site-config", {
+        ...request,
+        conversationId: input.state.conversationId ?? null
+    });
+    return response.site;
+}

package/dist/chatting-session-store.d.ts

@@ -1,3 +1,4 @@
-import type { ChattingKeyValueStorage, ChattingSessionStore } from "./chatting-types";
+import type { ChattingClientOptions, ChattingKeyValueStorage, ChattingSessionStore } from "./chatting-types";
+export declare function resolveChattingSessionStore(options: ChattingClientOptions): ChattingSessionStore;
 export declare function createMemorySessionStore(): ChattingSessionStore;
 export declare function createKeyValueSessionStore(storage: ChattingKeyValueStorage, namespace: string): ChattingSessionStore;

package/dist/chatting-session-store.js

@@ -1,3 +1,12 @@
+import AsyncStorage from "@react-native-async-storage/async-storage";
+export function resolveChattingSessionStore(options) {
+    if (options.sessionStore) {
+        return options.sessionStore;
+    }
+    return options.persistSession
+        ? createKeyValueSessionStore(AsyncStorage, options.siteId)
+        : createMemorySessionStore();
+}
 export function createMemorySessionStore() {
     let state = null;
     return {

package/dist/chatting-types.d.ts

@@ -98,6 +98,7 @@ export interface ChattingSiteStatus {
 export interface ChattingClientOptions {
     siteId: string;
     baseURL?: string;
+    persistSession?: boolean;
     sessionStore?: ChattingSessionStore;
     fetchImpl?: typeof fetch;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usechatting/react-native",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "React Native and Expo visitor chat SDK for Chatting.",
   "license": "Proprietary",
   "main": "dist/index.js",
@@ -14,6 +14,9 @@
   "scripts": {
     "build": "tsc -p tsconfig.json"
   },
+  "dependencies": {
+    "@react-native-async-storage/async-storage": "2.2.0"
+  },
   "peerDependencies": {
     "react": ">=18",
     "react-native": ">=0.74"