hubchat-react-native 0.0.0-stage → 1.0.1

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 HubChat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# hubchat-react-native
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+ویجت چت پشتیبانی هاب‌چت برای اپ‌های React Native (iOS و اندروید)، با همان ظاهر و امکانات ویجت سایت.
+
+```bash
+npm install hubchat-react-native react-native-webview
+cd ios && pod install
+```
+
+```tsx
+import { HubChatProvider, useHubChat } from 'hubchat-react-native';
+
+export default function App() {
+  return (
+    <HubChatProvider widgetKey="hc_xxxxxxxxxxxxxxxxxxxxxxxx" bottomOffset={56}>
+      <RootNavigator />
+    </HubChatProvider>
+  );
+}
+
+function SupportButton() {
+  const chat = useHubChat();
+  return <Button title="پشتیبانی" onPress={chat.open} />;
+}
+```
+
+| prop | توضیح |
+|---|---|
+| `widgetKey` | کلید ویجت از پنل (`hc_...`) |
+| `showLauncher` | نمایش دکمه‌ی شناور (پیش‌فرض `true`) |
+| `bottomOffset` | فاصله‌ی اضافه از پایین (مثلاً بالای تب‌بار) |
+| `onUnreadChange` | تعداد پیام‌های خوانده‌نشده |
+| `onEvent` | رویدادهای `ready`، `close`، `unread` |
+
+برای آپلود فایل در iOS این کلیدها را به `Info.plist` اضافه کنید: `NSCameraUsageDescription`، `NSPhotoLibraryUsageDescription`، `NSMicrophoneUsageDescription`.
+
+## نحوه‌ی کار
+تنظیمات دکمه از `GET https://widget.hubchat.ir/widget/{key}/config` خوانده و دکمه‌ی شناور به‌صورت نیتیو ساخته می‌شود. خود صفحه‌ی ویجت (`/widget/{key}`)، همان صفحه‌ای که روی سایت در iframe باز می‌شود، در WebView بارگذاری می‌شود؛ پس ظاهر و امکانات پنل دقیقاً مثل سایت است. SDK پیش از بارگذاری صفحه `window.HubChatBridge.postMessage` را تعریف می‌کند و ویجت رویدادهای `ready`، `close` و `unread` را از آن می‌فرستد.

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "hubchat-react-native",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.1",
+  "description": "HubChat support chat widget for React Native (iOS & Android)",
+  "main": "src/index.tsx",
+  "types": "src/index.tsx",
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "react": ">=17",
+    "react-native": ">=0.68",
+    "react-native-webview": ">=11"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HubChat-ai/HubChat-react-native.git"
+  },
+  "keywords": [
+    "hubchat",
+    "live-chat",
+    "chat",
+    "customer-support",
+    "react-native",
+    "webview"
+  ],
+  "homepage": "https://hubchat.ir",
+  "bugs": {
+    "url": "https://github.com/HubChat-ai/HubChat-react-native/issues"
+  },
+  "author": "HubChat"
+}

package/src/index.tsx

@@ -0,0 +1,218 @@
+import React, { createContext, forwardRef, useCallback, useContext, useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
+import { Animated, Image, Platform, Pressable, SafeAreaView, StyleSheet, Text, View, type ViewStyle } from 'react-native';
+import { WebView, type WebViewMessageEvent } from 'react-native-webview';
+import { contrastOn, DEFAULT_BASE_URL, faDigits, fetchSettings, hostCommand, widgetUrl, type HubChatEvent, type HubChatSettings } from './protocol';
+
+export type { HubChatSettings, HubChatEvent } from './protocol';
+
+export type HubChatProps = {
+    /** Widget key from the HubChat panel (hc_...). */
+    widgetKey: string;
+    /** Override the widget host (self-hosted / staging). */
+    baseUrl?: string;
+    /** Show the floating launcher button. Set false to open only via ref / useHubChat(). */
+    showLauncher?: boolean;
+    /** Extra offset of the launcher from the bottom (e.g. above a tab bar). */
+    bottomOffset?: number;
+    onEvent?: (event: HubChatEvent) => void;
+    onUnreadChange?: (count: number) => void;
+};
+
+export type HubChatHandle = { open: () => void; close: () => void; isOpen: () => boolean };
+
+const HubChatContext = createContext<HubChatHandle | null>(null);
+
+/** Access open/close from anywhere under <HubChatProvider>. */
+export function useHubChat(): HubChatHandle {
+    const handle = useContext(HubChatContext);
+
+    if (!handle) {
+        throw new Error('useHubChat must be used inside <HubChatProvider>.');
+    }
+
+    return handle;
+}
+
+const BRIDGE = `window.HubChatBridge={postMessage:function(m){window.ReactNativeWebView.postMessage(m);}};true;`;
+
+export const HubChat = forwardRef<HubChatHandle, HubChatProps>(function HubChat(
+    { widgetKey, baseUrl = DEFAULT_BASE_URL, showLauncher = true, bottomOffset = 0, onEvent, onUnreadChange },
+    ref,
+) {
+    const [settings, setSettings] = useState<HubChatSettings | null>(null);
+    const [open, setOpen] = useState(false);
+    const [unread, setUnread] = useState(0);
+    const [mounted, setMounted] = useState(false);
+    const webView = useRef<WebView>(null);
+    const openRef = useRef(false);
+    const pop = useRef(new Animated.Value(0)).current;
+
+    useEffect(() => {
+        let alive = true;
+
+        fetchSettings(baseUrl, widgetKey).then((value) => {
+            if (alive && value) {
+                setSettings(value);
+                Animated.spring(pop, { toValue: 1, useNativeDriver: true, friction: 6 }).start();
+            }
+        });
+        // Preload the page like widget.js does, so unread messages arrive while closed.
+        const timer = setTimeout(() => setMounted(true), 2500);
+
+        return () => {
+            alive = false;
+            clearTimeout(timer);
+        };
+    }, [baseUrl, widgetKey, pop]);
+
+    const changeUnread = useCallback((count: number) => {
+        setUnread(count);
+        onUnreadChange?.(count);
+    }, [onUnreadChange]);
+
+    const show = useCallback(() => {
+        setMounted(true);
+        openRef.current = true;
+        setOpen(true);
+        changeUnread(0);
+        webView.current?.injectJavaScript(hostCommand('open'));
+    }, [changeUnread]);
+
+    const hide = useCallback(() => {
+        openRef.current = false;
+        setOpen(false);
+        webView.current?.injectJavaScript(hostCommand('closed'));
+    }, []);
+
+    const handle = useMemo<HubChatHandle>(() => ({ open: show, close: hide, isOpen: () => openRef.current }), [show, hide]);
+
+    useImperativeHandle(ref, () => handle, [handle]);
+
+    const onMessage = (event: WebViewMessageEvent) => {
+        let data: (HubChatEvent & { source?: string }) | null = null;
+
+        try {
+            data = JSON.parse(event.nativeEvent.data);
+        } catch {
+            return;
+        }
+
+        if (!data || data.source !== 'hubchat') {
+            return;
+        }
+
+        if (data.type === 'close') {
+            hide();
+        }
+
+        if (data.type === 'ready' && openRef.current) {
+            webView.current?.injectJavaScript(hostCommand('open'));
+        }
+
+        if (data.type === 'unread' && !openRef.current) {
+            changeUnread(data.count);
+        }
+
+        onEvent?.(data);
+    };
+
+    const brand = settings?.color ?? '#2563eb';
+    const side: ViewStyle = settings?.position === 'right' ? { right: 20 } : { left: 20 };
+    const hasText = !!settings?.launcher_text;
+
+    return (
+        <View pointerEvents="box-none" style={StyleSheet.absoluteFill}>
+            {mounted && (
+                <SafeAreaView pointerEvents={open ? 'auto' : 'none'} style={[StyleSheet.absoluteFill, styles.panel, { opacity: open ? 1 : 0 }]}>
+                    <WebView
+                        ref={webView}
+                        source={{ uri: widgetUrl(baseUrl, widgetKey) }}
+                        injectedJavaScriptBeforeContentLoaded={BRIDGE}
+                        onMessage={onMessage}
+                        javaScriptEnabled
+                        domStorageEnabled
+                        allowFileAccess
+                        mediaPlaybackRequiresUserAction={false}
+                        allowsInlineMediaPlayback
+                        setSupportMultipleWindows={false}
+                        style={styles.webView}
+                    />
+                </SafeAreaView>
+            )}
+            {showLauncher && settings && !open && (
+                <Animated.View style={[styles.launcherWrap, side, { bottom: 20 + bottomOffset, transform: [{ scale: pop }] }]}>
+                    <Pressable
+                        accessibilityRole="button"
+                        accessibilityLabel="گفتگوی آنلاین"
+                        onPress={show}
+                        style={[styles.launcher, hasText ? styles.launcherWide : styles.launcherRound, { backgroundColor: brand, shadowColor: brand }]}
+                    >
+                        {settings.launcher_image ? (
+                            <Image source={{ uri: settings.launcher_image }} style={hasText ? styles.picSmall : styles.pic} />
+                        ) : (
+                            <ChatGlyph color={contrastOn(brand)} />
+                        )}
+                        {hasText && <Text style={[styles.label, { color: contrastOn(brand) }]}>{settings.launcher_text}</Text>}
+                    </Pressable>
+                    {unread > 0 && (
+                        <View style={[styles.badge, settings.position === 'right' ? { left: -4 } : { right: -4 }]}>
+                            <Text style={styles.badgeText}>{faDigits(unread > 9 ? '9+' : unread)}</Text>
+                        </View>
+                    )}
+                </Animated.View>
+            )}
+        </View>
+    );
+});
+
+/** Chat bubble with three dots, drawn with Views (no SVG dependency). */
+function ChatGlyph({ color }: { color: string }) {
+    return (
+        <View style={[styles.glyph, { borderColor: color }]}>
+            {[0, 1, 2].map((dot) => (
+                <View key={dot} style={[styles.dot, { backgroundColor: color }]} />
+            ))}
+        </View>
+    );
+}
+
+/** Wrap your app to get useHubChat() everywhere and the launcher on every screen. */
+export function HubChatProvider({ children, ...props }: HubChatProps & { children: React.ReactNode }) {
+    const ref = useRef<HubChatHandle>(null);
+    const handle = useMemo<HubChatHandle>(() => ({
+        open: () => ref.current?.open(),
+        close: () => ref.current?.close(),
+        isOpen: () => ref.current?.isOpen() ?? false,
+    }), []);
+
+    return (
+        <HubChatContext.Provider value={handle}>
+            <View style={styles.flex}>
+                {children}
+                <HubChat ref={ref} {...props} />
+            </View>
+        </HubChatContext.Provider>
+    );
+}
+
+const styles = StyleSheet.create({
+    flex: { flex: 1 },
+    panel: { backgroundColor: '#f4f6fa', zIndex: 1000, elevation: 1000 },
+    webView: { flex: 1, backgroundColor: 'transparent' },
+    launcherWrap: { position: 'absolute', zIndex: 999, elevation: 12 },
+    launcher: {
+        height: 60, minWidth: 60, borderRadius: 999, flexDirection: 'row-reverse', alignItems: 'center', justifyContent: 'center',
+        shadowOpacity: 0.45, shadowRadius: 14, shadowOffset: { width: 0, height: 8 }, elevation: 10, overflow: Platform.OS === 'android' ? 'hidden' : 'visible',
+    },
+    launcherRound: { width: 60 },
+    launcherWide: { paddingHorizontal: 16, gap: 10 },
+    label: { fontSize: 15, fontWeight: '700' },
+    pic: { width: 60, height: 60, borderRadius: 30 },
+    picSmall: { width: 44, height: 44, borderRadius: 22 },
+    glyph: { width: 26, height: 22, borderWidth: 2, borderRadius: 11, borderBottomLeftRadius: 3, flexDirection: 'row', alignItems: 'center', justifyContent: 'center', gap: 3 },
+    dot: { width: 3.5, height: 3.5, borderRadius: 2 },
+    badge: { position: 'absolute', top: -4, minWidth: 22, height: 22, paddingHorizontal: 6, borderRadius: 11, backgroundColor: '#ef4444', borderWidth: 3, borderColor: '#fff', alignItems: 'center', justifyContent: 'center' },
+    badgeText: { color: '#fff', fontSize: 11, fontWeight: '800' },
+});
+
+export default HubChat;

package/src/protocol.ts

@@ -0,0 +1,54 @@
+/**
+ * Shared protocol with the HubChat widget page (/widget/{key}).
+ * The page calls window.HubChatBridge.postMessage(json) for: ready, close, unread.
+ * The host opens/closes the panel with window.postMessage({source:'hubchat-loader', type}).
+ */
+export const DEFAULT_BASE_URL = 'https://widget.hubchat.ir';
+
+export type HubChatSettings = {
+    color: string;
+    position: 'left' | 'right';
+    launcher_text?: string | null;
+    launcher_image?: string | null;
+    title?: string | null;
+    subtitle?: string | null;
+};
+
+export type HubChatEvent =
+    | { type: 'ready' }
+    | { type: 'close' }
+    | { type: 'unread'; count: number; preview?: string; agent?: string | null };
+
+export function widgetUrl(baseUrl: string, widgetKey: string): string {
+    return `${baseUrl.replace(/\/$/, '')}/widget/${widgetKey}`;
+}
+
+export async function fetchSettings(baseUrl: string, widgetKey: string): Promise<HubChatSettings | null> {
+    try {
+        const response = await fetch(`${widgetUrl(baseUrl, widgetKey)}/config`);
+        const data = response.ok ? await response.json() : null;
+
+        return data?.settings ?? null;
+    } catch {
+        return null;
+    }
+}
+
+export function hostCommand(type: 'open' | 'closed'): string {
+    return `window.postMessage({source:'hubchat-loader',type:'${type}'},'*');true;`;
+}
+
+/** Same contrast rule as widget.js so launcher text color matches the website. */
+export function contrastOn(hex: string): string {
+    const channel = (offset: number) => {
+        const value = parseInt(hex.slice(offset, offset + 2), 16) / 255;
+
+        return value <= 0.03928 ? value / 12.92 : Math.pow((value + 0.055) / 1.055, 2.4);
+    };
+
+    return 0.2126 * channel(1) + 0.7152 * channel(3) + 0.0722 * channel(5) > 0.45 ? '#0b1220' : '#ffffff';
+}
+
+export function faDigits(value: string | number): string {
+    return String(value).replace(/\d/g, (digit) => '۰۱۲۳۴۵۶۷۸۹'[Number(digit)]);
+}