@vserifsaglam/chat-react-client 1.0.2

package/dist/types.d.ts

@@ -0,0 +1,248 @@
+/**
+ * Type definitions for the Chat API
+ */
+import { LoggerConfig } from './utils/Logger';
+export declare enum ConnectionType {
+    WebSocket = "websocket",
+    LongPolling = "longpolling"
+}
+export declare enum ConnectionStatus {
+    Connected = "connected",
+    Connecting = "connecting",
+    Disconnected = "disconnected",
+    Error = "error"
+}
+export interface ConnectionConfig {
+    type: ConnectionType;
+    autoReconnect: boolean;
+    reconnectAttempts: number;
+    reconnectDelay: number;
+    logging?: Partial<LoggerConfig>;
+    onlyLongpolling?: boolean;
+    degradeWsOnFailure?: boolean;
+    wsFailureThreshold?: number;
+    wsDegradeTTLms?: number;
+    forceWebSocket?: boolean;
+}
+export interface ConnectionOptions {
+    connectionType?: ConnectionType;
+    autoReconnect?: boolean;
+    reconnectAttempts?: number;
+    reconnectDelay?: number;
+    logging?: Partial<LoggerConfig>;
+    onlyLongpolling?: boolean;
+    degradeWsOnFailure?: boolean;
+    wsFailureThreshold?: number;
+    wsDegradeTTLms?: number;
+    forceWebSocket?: boolean;
+}
+export declare enum EventType {
+    MessageSent = "message_sent",
+    MessageEdited = "message_edited",
+    MessageDeleted = "message_deleted",
+    MessageReceived = "message_received",
+    MessageRead = "message_read",
+    ConversationRead = "conversation_read"
+}
+export interface RealtimeEvent<T = any> {
+    type: EventType;
+    data: T;
+}
+export interface MessageSentEvent {
+    id: number;
+    content: string;
+    sender_client_id: string;
+    receiver_client_id: string;
+    sent_at: string;
+    is_read: boolean;
+    attachments?: Attachment[];
+    conversation_uid?: string;
+}
+export interface MessageEditedEvent {
+    msg_id: number;
+    new_content: string;
+    new_attachments?: Attachment[];
+    conversation_uid?: string;
+}
+export interface MessageDeletedEvent {
+    msg_id: number;
+    conversation_uid?: string;
+}
+export interface MessageReadEvent {
+    message_id: number;
+    reader_client_id: string;
+    conversation_uid: string;
+    sender_client_id?: string;
+}
+export interface ConversationReadEvent {
+    conversation_uid: string;
+    reader_client_id: string;
+    message_ids: number[];
+    other_client_id?: string;
+}
+export interface PollResponse {
+    events: RealtimeEvent[];
+}
+export interface QueuedMessage {
+    id: string;
+    message: SendMessageRequest;
+    attempts: number;
+    maxAttempts: number;
+    timestamp: number;
+}
+export interface AuthConfig {
+    token: string;
+    baseUrl: string;
+    socketBaseUrl: string;
+    client_id: string;
+}
+export interface User {
+    id: string;
+    client_id: string;
+    name: string;
+    avatar: string;
+    is_admin: boolean;
+    attributes: Record<string, any>;
+    file_storage_provider: string;
+    owner_client_id: string;
+}
+export interface Conversation {
+    id: string;
+    conversation_uid: string;
+    status: string;
+    user: User;
+    isArchived: boolean;
+    isCallCenter: boolean;
+    lastMessage: Message;
+    unreadCount: number;
+}
+export interface ConversationSearchResult {
+    conversation_uid: string;
+    search_term: string;
+    matching_messages: Message[];
+    count: number;
+}
+export interface Attachment {
+    id: number;
+    filename: string;
+    mime_type: string;
+    size_bytes: number;
+    url: string;
+    uploaded_at: string;
+    message_id?: number;
+}
+export interface SenderReceiverUser {
+    id: string;
+    client_id: string;
+    name: string;
+    avatar: string;
+}
+export interface Message {
+    id: number;
+    message: string;
+    sender: SenderReceiverUser;
+    receiver: SenderReceiverUser;
+    sender_client_id: string;
+    receiver_client_id: string;
+    edited: boolean;
+    conversation_uid: string;
+    sent_at: string;
+    status: string;
+    is_read: boolean;
+    attachments?: Attachment[];
+}
+export interface MessagesPagination {
+    page: number;
+    page_size: number;
+    total_pages: number;
+    total_items: number;
+}
+export interface MessagesResponse {
+    messages: Message[];
+    pagination: MessagesPagination;
+}
+export interface SendMessageRequest {
+    receiver_client_id: string;
+    content?: string;
+    attachments?: number[];
+    conversation_uid?: string;
+}
+export interface UpdateMessageRequest {
+    content: string;
+    attachments?: number[];
+}
+export interface ApiResponse {
+    message: string;
+}
+export interface ClientProfileResponse {
+    id: string;
+    client_id: string;
+    name: string;
+    avatar: string;
+    is_admin: boolean;
+    attributes: Record<string, any>;
+    file_storage_provider: string | null;
+    owner_client_id: string | null;
+    private_key?: string;
+}
+export interface SendMessageResponse {
+    message: Message;
+}
+export interface MarkConversationReadResponse extends ApiResponse {
+    marked_messages: number[];
+    count: number;
+}
+export interface UpdateMessageResponse {
+    message: Message;
+}
+export interface DeleteMessageResponse extends ApiResponse {
+    message_id: number;
+}
+export interface FileUploadResponse extends ApiResponse {
+    file_id: number;
+    filename: string;
+    storage_path: string;
+    mime_type: string;
+    size_bytes: number;
+    url: string;
+    uploaded_at: string;
+}
+export interface BanClientRequest {
+    client_id: string;
+}
+export interface UnbanClientRequest {
+    client_id: string;
+}
+export interface AdminBanClientRequest {
+    client_id: string;
+    reason?: string;
+    duration_days?: number;
+}
+export interface AdminUnbanClientRequest {
+    client_id: string;
+}
+export interface AdminBanInfo {
+    reason?: string;
+    expires_at?: string;
+    is_permanent: boolean;
+}
+export interface BanStatusResponse {
+    is_banned_by_you: boolean;
+    is_banned_by_admin: boolean;
+    admin_ban?: AdminBanInfo;
+}
+export interface ClientPreferences {
+    enable_read: boolean;
+}
+export interface ClientPreferencesResponse {
+    preferences: ClientPreferences;
+    client_id: number;
+}
+export interface UpdatePreferencesRequest {
+    preferences: Partial<ClientPreferences>;
+}
+export interface UpdatePreferencesResponse {
+    message: string;
+    preferences: ClientPreferences;
+    updated_at: string;
+}

package/dist/utils/Logger.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Logger utility for detailed websocket connection logging
+ */
+export declare enum LogLevel {
+    DEBUG = 0,
+    INFO = 1,
+    WARN = 2,
+    ERROR = 3,
+    NONE = 4
+}
+export interface LoggerConfig {
+    enabled: boolean;
+    level: LogLevel;
+    prefix?: string;
+    timestamp?: boolean;
+    includeData?: boolean;
+    prettyPrint?: boolean;
+}
+export declare class Logger {
+    private config;
+    constructor(config?: Partial<LoggerConfig>);
+    private shouldLog;
+    private formatMessage;
+    private formatData;
+    private maskSensitiveData;
+    debug(message: string, data?: any): void;
+    info(message: string, data?: any): void;
+    warn(message: string, data?: any): void;
+    error(message: string, data?: any): void;
+    group(label: string): void;
+    groupEnd(): void;
+    time(label: string): void;
+    timeEnd(label: string): void;
+    updateConfig(config: Partial<LoggerConfig>): void;
+    getConfig(): LoggerConfig;
+}
+export default Logger;

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@vserifsaglam/chat-react-client",
+  "version": "1.0.2",
+  "description": "Frontend library to easliy connect to the chat",
+  "author": "vahit",
+  "license": "MIT",
+  "repository": "",
+  "main": "dist/index.js",
+  "module": "dist/index.modern.js",
+  "source": "src/index.tsx",
+  "engines": {
+    "node": ">=10"
+  },
+  "scripts": {
+    "build": "microbundle-crl --no-compress --format modern,cjs",
+    "start": "microbundle-crl watch --no-compress --format modern,cjs",
+    "prepare": "run-s build",
+    "test": "run-s test:unit test:lint test:build",
+    "test:build": "run-s build",
+    "test:lint": "eslint . --ext .js,.jsx,.ts,.tsx --fix",
+    "test:unit": "cross-env CI=1 react-scripts test --env=jsdom",
+    "test:watch": "react-scripts test --env=jsdom",
+    "predeploy": "cd example && yarn install && yarn run build",
+    "deploy": "gh-pages -d example/build"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0"
+  },
+  "dependencies": {
+    "axios": "^0.21.1",
+    "babel-plugin-transform-async-to-promises": "0.8.18",
+    "socket.io-client": "4.8.1"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^4.2.4",
+    "@testing-library/react": "^9.5.0",
+    "@testing-library/user-event": "^7.2.1",
+    "@types/jest": "^25.1.4",
+    "@types/node": "^12.12.38",
+    "@types/react": "^16.9.27",
+    "@types/react-dom": "^16.9.7",
+    "@typescript-eslint/eslint-plugin": "^2.26.0",
+    "@typescript-eslint/parser": "^2.26.0",
+    "microbundle-crl": "^0.13.10",
+    "babel-eslint": "^10.0.3",
+    "cross-env": "^7.0.2",
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.7.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-config-standard-react": "^9.2.0",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-node": "^11.0.0",
+    "eslint-plugin-prettier": "^3.1.1",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-react": "^7.17.0",
+    "eslint-plugin-standard": "^4.0.1",
+    "gh-pages": "^2.2.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.0.4",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-scripts": "^3.4.1",
+    "typescript": "^3.7.5"
+  },
+  "files": [
+    "dist"
+  ]
+}