@osise/api-client 0.0.9 → 0.0.11

package/dist/types/types/realtime.d.ts

@@ -0,0 +1,134 @@
+/**
+ * Real-time types for SignalR communication
+ * Defines event payloads for chat and notification hubs
+ */
+/** SignalR connection state */
+export type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'reconnecting';
+/** Configuration for real-time connections */
+export interface RealTimeConfig {
+    /** Base URL for the API (same as REST API base URL) */
+    baseUrl: string;
+    /** Function that returns the current JWT access token */
+    accessTokenFactory: () => string | null;
+    /** Enable automatic reconnection (default: true) */
+    autoReconnect?: boolean;
+    /** Reconnection delay intervals in milliseconds (default: [0, 2000, 5000, 10000, 30000]) */
+    reconnectDelays?: number[];
+    /** Enable debug logging (default: false) */
+    debug?: boolean;
+}
+/** New message received in a conversation */
+export interface ReceiveMessageEvent {
+    id: string;
+    conversationId: string;
+    type: string;
+    content?: string;
+    senderId?: string;
+    senderName?: string;
+    senderPhotoUrl?: string;
+    isSystemMessage: boolean;
+    media?: {
+        url: string;
+        fileName?: string;
+        fileSize?: number;
+        contentType?: string;
+        duration?: number;
+        thumbnailUrl?: string;
+    };
+    location?: {
+        latitude: number;
+        longitude: number;
+        label?: string;
+    };
+    replyTo?: {
+        id: string;
+        type: string;
+        contentPreview?: string;
+        senderName: string;
+    };
+    createdAt: string;
+}
+/** Typing indicator from another user */
+export interface TypingIndicatorEvent {
+    conversationId: string;
+    userId: string;
+    isTyping: boolean;
+    timestamp: string;
+}
+/** Message delivery confirmation */
+export interface MessageDeliveredEvent {
+    conversationId: string;
+    messageId: string;
+    deliveredAt: string;
+}
+/** Messages marked as read by the other participant */
+export interface MessagesReadEvent {
+    conversationId: string;
+    messageIds: string[];
+    readAt: string;
+}
+/** Message was edited by the sender */
+export interface MessageEditedEvent {
+    conversationId: string;
+    messageId: string;
+    newContent: string;
+    editedAt: string;
+}
+/** Message was deleted by the sender */
+export interface MessageDeletedEvent {
+    conversationId: string;
+    messageId: string;
+    timestamp: string;
+}
+/** User online/offline status change */
+export interface UserPresenceEvent {
+    userId: string;
+    isOnline: boolean;
+    lastSeenAt: string;
+}
+/** New notification received */
+export interface ReceiveNotificationEvent {
+    id: string;
+    type: string;
+    priority: string;
+    title: string;
+    body: string;
+    imageUrl?: string;
+    actionUrl?: string;
+    actionType?: string;
+    relatedEntityId?: string;
+    relatedEntityType?: string;
+    isRead: boolean;
+    readAt?: string;
+    data?: Record<string, unknown>;
+    createdAt: string;
+    expiresAt?: string;
+}
+/** Updated unread notification count */
+export interface NotificationCountEvent {
+    unreadCount: number;
+    timestamp: string;
+}
+/** Chat hub event handlers */
+export interface ChatEventHandlers {
+    onMessage?: (message: ReceiveMessageEvent) => void;
+    onTypingIndicator?: (event: TypingIndicatorEvent) => void;
+    onMessageDelivered?: (event: MessageDeliveredEvent) => void;
+    onMessagesRead?: (event: MessagesReadEvent) => void;
+    onMessageEdited?: (event: MessageEditedEvent) => void;
+    onMessageDeleted?: (event: MessageDeletedEvent) => void;
+    onUserPresenceChanged?: (event: UserPresenceEvent) => void;
+}
+/** Notification hub event handlers */
+export interface NotificationEventHandlers {
+    onNotification?: (notification: ReceiveNotificationEvent) => void;
+    onNotificationCountUpdated?: (event: NotificationCountEvent) => void;
+}
+/** Combined connection event handlers */
+export interface ConnectionEventHandlers {
+    onConnected?: () => void;
+    onDisconnected?: (error?: Error) => void;
+    onReconnecting?: (error?: Error) => void;
+    onReconnected?: (connectionId?: string) => void;
+}
+//# sourceMappingURL=realtime.d.ts.map

package/dist/types/types/realtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.d.ts","sourceRoot":"","sources":["../../../src/types/realtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,+BAA+B;AAC/B,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,CAAC;AAE3F,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,yDAAyD;IACzD,kBAAkB,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACxC,oDAAoD;IACpD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,4FAA4F;IAC5F,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,4CAA4C;IAC5C,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAMD,6CAA6C;AAC7C,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,CAAC,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yCAAyC;AACzC,MAAM,WAAW,oBAAoB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,oCAAoC;AACpC,MAAM,WAAW,qBAAqB;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,uDAAuD;AACvD,MAAM,WAAW,iBAAiB;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wCAAwC;AACxC,MAAM,WAAW,mBAAmB;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAMD,gCAAgC;AAChC,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wCAAwC;AACxC,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD,8BAA8B;AAC9B,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACnD,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC1D,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAC5D,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACpD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACtD,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACxD,qBAAqB,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;CAC5D;AAED,sCAAsC;AACtC,MAAM,WAAW,yBAAyB;IACxC,cAAc,CAAC,EAAE,CAAC,YAAY,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAClE,0BAA0B,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;CACtE;AAED,yCAAyC;AACzC,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IACzB,cAAc,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;IACzC,cAAc,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;IACzC,aAAa,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACjD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osise/api-client",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Official TypeScript SDK for the Osise API - connecting consumers with skilled artisans",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -53,6 +53,9 @@
     "url": "https://github.com/osise/osise-api-client/issues"
   },
   "homepage": "https://github.com/osise/osise-api-client#readme",
+  "dependencies": {
+    "@microsoft/signalr": "^8.0.17"
+  },
   "peerDependencies": {
     "react": ">=17.0.0"
   },
@@ -64,13 +67,13 @@
   "devDependencies": {
     "@types/node": "^20.0.0",
     "@types/react": "^18.2.0",
-    "react": "^18.2.0",
-    "typescript": "^5.4.0",
-    "vitest": "^1.6.0",
-    "eslint": "^8.57.0",
     "@typescript-eslint/eslint-plugin": "^7.0.0",
     "@typescript-eslint/parser": "^7.0.0",
-    "eslint-plugin-react-hooks": "^4.6.0"
+    "eslint": "^8.57.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "react": "^18.2.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.0"
   },
   "engines": {
     "node": ">=18.0.0"