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

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

@@ -2,8 +2,8 @@ import { SubscriptionClient } from './client';
 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, Notification, } from './types';
+export { NetworkError, NOTIFICATION_PRIORITIES, BONDS_EVENT_INNER_TYPES, } 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/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NOTIFICATION_TYPE_INSTITUTIONAL_SELECT = exports.NOTIFICATION_TYPE_SAM_AUCTION = exports.NetworkError = exports.listSubscriptionsMessage = exports.unsubscribeMessage = exports.subscribeMessage = exports.SubscriptionClient = void 0;
+exports.NOTIFICATION_TYPE_INSTITUTIONAL_SELECT = exports.NOTIFICATION_TYPE_SAM_AUCTION = exports.BONDS_EVENT_INNER_TYPES = exports.NOTIFICATION_PRIORITIES = exports.NetworkError = exports.listSubscriptionsMessage = exports.unsubscribeMessage = exports.subscribeMessage = exports.SubscriptionClient = void 0;
 exports.createSubscriptionClient = createSubscriptionClient;
 const client_1 = require("./client");
 Object.defineProperty(exports, "SubscriptionClient", { enumerable: true, get: function () { return client_1.SubscriptionClient; } });
@@ -10,6 +10,8 @@ Object.defineProperty(exports, "unsubscribeMessage", { enumerable: true, get: fu
 Object.defineProperty(exports, "listSubscriptionsMessage", { enumerable: true, get: function () { return message_1.listSubscriptionsMessage; } });
 var types_1 = require("./types");
 Object.defineProperty(exports, "NetworkError", { enumerable: true, get: function () { return types_1.NetworkError; } });
+Object.defineProperty(exports, "NOTIFICATION_PRIORITIES", { enumerable: true, get: function () { return types_1.NOTIFICATION_PRIORITIES; } });
+Object.defineProperty(exports, "BONDS_EVENT_INNER_TYPES", { enumerable: true, get: function () { return types_1.BONDS_EVENT_INNER_TYPES; } });
 exports.NOTIFICATION_TYPE_SAM_AUCTION = 'sam_auction';
 exports.NOTIFICATION_TYPE_INSTITUTIONAL_SELECT = 'institutional_select';
 function createSubscriptionClient(config) {

package/dist/types.d.ts

@@ -66,28 +66,33 @@ 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 declare const NOTIFICATION_PRIORITIES: readonly ["critical", "warning", "info"];
+export type NotificationPriority = (typeof NOTIFICATION_PRIORITIES)[number];
+export declare const BONDS_EVENT_INNER_TYPES: readonly ["first_seen", "bond_removed", "auction_entered", "auction_exited", "cap_changed", "bond_underfunded_change", "bond_balance_change", "announcement", "version_bump", "sam_eligible_change"];
+export type BondsEventInnerType = (typeof BONDS_EVENT_INNER_TYPES)[number];
 /** 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>;

package/dist/types.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkError = void 0;
+exports.NetworkError = exports.BONDS_EVENT_INNER_TYPES = exports.NOTIFICATION_PRIORITIES = void 0;
+// Keep in sync with notifications-bonds/src/types.ts NotificationPriority
+exports.NOTIFICATION_PRIORITIES = ['critical', 'warning', 'info'];
+// Keep in sync with notifications-bonds-event-v1 BondsEventInnerType
+exports.BONDS_EVENT_INNER_TYPES = [
+    'first_seen',
+    'bond_removed',
+    'auction_entered',
+    'auction_exited',
+    'cap_changed',
+    'bond_underfunded_change',
+    'bond_balance_change',
+    'announcement',
+    'version_bump',
+    'sam_eligible_change',
+];
 class NetworkError extends Error {
     constructor(message, status, response) {
         super(message);

package/index.ts

@@ -8,7 +8,11 @@ export {
   unsubscribeMessage,
   listSubscriptionsMessage,
 } from './message'
-export { NetworkError } from './types'
+export {
+  NetworkError,
+  NOTIFICATION_PRIORITIES,
+  BONDS_EVENT_INNER_TYPES,
+} from './types'
 export type {
   Logger,
   SubscriptionClientConfig,
@@ -20,7 +24,11 @@ export type {
   ListSubscriptionsAuth,
   Subscription,
   ListNotificationsQuery,
+  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.4",
+  "version": "1.0.3",
   "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,43 @@ 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 const NOTIFICATION_PRIORITIES = ['critical', 'warning', 'info'] as const
+export type NotificationPriority = (typeof NOTIFICATION_PRIORITIES)[number]
+
+// Keep in sync with notifications-bonds-event-v1 BondsEventInnerType
+export const BONDS_EVENT_INNER_TYPES = [
+  'first_seen',
+  'bond_removed',
+  'auction_entered',
+  'auction_exited',
+  'cap_changed',
+  'bond_underfunded_change',
+  'bond_balance_change',
+  'announcement',
+  'version_bump',
+  'sam_eligible_change',
+] as const
+export type BondsEventInnerType = (typeof BONDS_EVENT_INNER_TYPES)[number]
+
 /** 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>