@marinade.finance/notifications-ts-subscription-client 1.0.2-beta.3 → 1.0.2

package/__tests__/client.test.ts

@@ -316,6 +316,93 @@ describe('SubscriptionClient', () => {
     })
   })
 
+  describe('listBroadcastNotifications', () => {
+    it('should send GET request to /broadcast with query params', async () => {
+      const mockFetch = global.fetch as jest.Mock
+      const responseBody = [
+        {
+          id: '1',
+          notification_type: 'sam_auction',
+          inner_type: 'announcement',
+          user_id: 'broadcast',
+          scope: 'broadcast',
+          priority: 'critical',
+          title: 'Test announcement',
+          message: 'Test announcement body',
+          data: {},
+          notification_id: null,
+          relevance_until: '2025-01-15T00:00:00Z',
+          created_at: '2025-01-01T00:00:00Z',
+        },
+      ]
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: () => Promise.resolve(responseBody),
+      } as Response)
+
+      const client = createSubscriptionClient({
+        base_url: 'http://localhost:3000',
+      })
+
+      const result = await client.listBroadcastNotifications({
+        notification_type: 'sam_auction',
+        priority: 'critical',
+        inner_type: 'announcement',
+        limit: 10,
+        offset: 5,
+      })
+
+      expect(result).toEqual(responseBody)
+      expect(mockFetch).toHaveBeenCalledTimes(1)
+      const [url, options] = mockFetch.mock.calls[0]
+      const parsed = new URL(url)
+      expect(parsed.pathname).toBe('/v1/notifications/broadcast')
+      expect(parsed.searchParams.get('notification_type')).toBe('sam_auction')
+      expect(parsed.searchParams.get('priority')).toBe('critical')
+      expect(parsed.searchParams.get('inner_type')).toBe('announcement')
+      expect(parsed.searchParams.get('limit')).toBe('10')
+      expect(parsed.searchParams.get('offset')).toBe('5')
+      expect(options?.method).toBe('GET')
+    })
+
+    it('should omit optional query params when not provided', async () => {
+      const mockFetch = global.fetch as jest.Mock
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: () => Promise.resolve([]),
+      } as Response)
+
+      const client = createSubscriptionClient({
+        base_url: 'http://localhost:3000',
+      })
+
+      await client.listBroadcastNotifications({})
+
+      const [url] = mockFetch.mock.calls[0]
+      expect(url).toBe('http://localhost:3000/v1/notifications/broadcast')
+    })
+
+    it('should throw NetworkError on HTTP error', async () => {
+      const mockFetch = global.fetch as jest.Mock
+      mockFetch.mockResolvedValue({
+        ok: false,
+        status: 500,
+        statusText: 'Internal Server Error',
+        text: () => Promise.resolve('server error'),
+      } as Response)
+
+      const client = createSubscriptionClient({
+        base_url: 'http://localhost:3000',
+      })
+
+      await expect(
+        client.listBroadcastNotifications({
+          notification_type: 'sam_auction',
+        }),
+      ).rejects.toThrow(NetworkError)
+    })
+  })
+
   describe('timeout', () => {
     it('should throw NetworkError on timeout', async () => {
       const mockFetch = global.fetch as jest.Mock

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import type { SubscriptionClientConfig } from './types';
 export { SubscriptionClient };
 export { subscribeMessage, unsubscribeMessage, listSubscriptionsMessage, } from './message';
 export { NetworkError } from './types';
-export type { Logger, SubscriptionClientConfig, SubscribeRequest, SubscribeResponse, UnsubscribeRequest, UnsubscribeResponse, ListSubscriptionsQuery, ListSubscriptionsAuth, Subscription, ListNotificationsQuery, ListBroadcastNotificationsQuery, Notification, NotificationScope, } from './types';
+export type { Logger, SubscriptionClientConfig, SubscribeRequest, SubscribeResponse, UnsubscribeRequest, UnsubscribeResponse, ListSubscriptionsQuery, ListSubscriptionsAuth, Subscription, ListNotificationsQuery, ListBroadcastNotificationsQuery, Notification, NotificationScope, NotificationPriority, BondsEventInnerType, } from './types';
 export declare const NOTIFICATION_TYPE_SAM_AUCTION = "sam_auction";
 export declare const NOTIFICATION_TYPE_INSTITUTIONAL_SELECT = "institutional_select";
 export declare function createSubscriptionClient(config: SubscriptionClientConfig): SubscriptionClient;

package/dist/types.d.ts

@@ -66,28 +66,32 @@ export interface Subscription {
 export interface ListNotificationsQuery {
     user_id: string;
     notification_type?: string;
-    priority?: string;
-    inner_type?: string;
+    priority?: NotificationPriority;
+    inner_type?: BondsEventInnerType;
     limit?: number;
     offset?: number;
 }
 /** GET /v1/notifications/broadcast query (public, no auth required) */
 export interface ListBroadcastNotificationsQuery {
     notification_type?: string;
-    priority?: string;
-    inner_type?: string;
+    priority?: NotificationPriority;
+    inner_type?: BondsEventInnerType;
     limit?: number;
     offset?: number;
 }
 export type NotificationScope = 'broadcast' | 'individual';
+export type NotificationPriority = 'critical' | 'warning' | 'info';
+export type BondsEventInnerType = 'first_seen' | 'bond_removed' | 'auction_entered' | 'auction_exited' | 'cap_changed' | 'bond_underfunded_change' | 'bond_balance_change' | 'announcement' | 'version_bump' | 'sam_eligible_change';
 /** GET /v1/notifications response item */
 export interface Notification {
-    id: number;
+    /** BIGSERIAL in PostgreSQL, serialized as string via JSON replacer */
+    id: string;
     notification_type: string;
-    inner_type: string;
+    inner_type: BondsEventInnerType;
     user_id: string;
     scope: NotificationScope;
-    priority: string;
+    priority: NotificationPriority;
+    title: string | null;
     message: string;
     data: Record<string, unknown>;
     notification_id: string | null;

package/index.ts

@@ -23,6 +23,8 @@ export type {
   ListBroadcastNotificationsQuery,
   Notification,
   NotificationScope,
+  NotificationPriority,
+  BondsEventInnerType,
 } from './types'
 
 export const NOTIFICATION_TYPE_SAM_AUCTION = 'sam_auction'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marinade.finance/notifications-ts-subscription-client",
-  "version": "1.0.2-beta.3",
+  "version": "1.0.2",
   "private": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/types.ts

@@ -87,8 +87,8 @@ export interface Subscription {
 export interface ListNotificationsQuery {
   user_id: string
   notification_type?: string
-  priority?: string
-  inner_type?: string
+  priority?: NotificationPriority
+  inner_type?: BondsEventInnerType
   limit?: number
   offset?: number
 }
@@ -96,23 +96,41 @@ export interface ListNotificationsQuery {
 /** GET /v1/notifications/broadcast query (public, no auth required) */
 export interface ListBroadcastNotificationsQuery {
   notification_type?: string
-  priority?: string
-  inner_type?: string
+  priority?: NotificationPriority
+  inner_type?: BondsEventInnerType
   limit?: number
   offset?: number
 }
 
-// Keep in sync with notification-service/notifications/notifications.constants.ts NotificationScope
+// Keep in sync with notification-service/notifications/notifications.constants.ts
 export type NotificationScope = 'broadcast' | 'individual'
 
+// Keep in sync with notifications-bonds/src/types.ts NotificationPriority
+export type NotificationPriority = 'critical' | 'warning' | 'info'
+
+// Keep in sync with notifications-bonds-event-v1 BondsEventInnerType
+export type BondsEventInnerType =
+  | 'first_seen'
+  | 'bond_removed'
+  | 'auction_entered'
+  | 'auction_exited'
+  | 'cap_changed'
+  | 'bond_underfunded_change'
+  | 'bond_balance_change'
+  | 'announcement'
+  | 'version_bump'
+  | 'sam_eligible_change'
+
 /** GET /v1/notifications response item */
 export interface Notification {
-  id: number
+  /** BIGSERIAL in PostgreSQL, serialized as string via JSON replacer */
+  id: string
   notification_type: string
-  inner_type: string
+  inner_type: BondsEventInnerType
   user_id: string
   scope: NotificationScope
-  priority: string
+  priority: NotificationPriority
+  title: string | null
   message: string
   data: Record<string, unknown>
   notification_id: string | null