@marinade.finance/ts-subscription-client 1.0.0-beta.1

package/types.ts

@@ -0,0 +1,119 @@
+/** Minimal logger interface — compatible with pino, console, etc. */
+export interface Logger {
+  debug(msg: string): void
+}
+
+/** Configuration for the subscription client */
+export interface SubscriptionClientConfig {
+  base_url: string
+  timeout_ms?: number
+  logger?: Logger
+}
+
+/** POST /subscriptions request */
+export interface SubscribeRequest {
+  pubkey: string
+  notification_type: string
+  channel: string
+  channel_address: string
+  signature: string
+  message: string
+  additional_data?: Record<string, unknown>
+}
+
+/** DELETE /subscriptions request */
+export interface UnsubscribeRequest {
+  pubkey: string
+  notification_type: string
+  channel: string
+  channel_address?: string
+  signature: string
+  message: string
+  additional_data?: Record<string, unknown>
+}
+
+/** GET /subscriptions auth */
+export interface ListSubscriptionsAuth {
+  signature: string
+  message: string
+}
+
+/** GET /subscriptions query */
+export interface ListSubscriptionsQuery {
+  pubkey: string
+  notification_type?: string
+  additional_data?: Record<string, unknown>
+}
+
+/** POST /subscriptions response */
+export interface SubscribeResponse {
+  user_id: string
+  notification_type: string
+  channel: string
+  channel_address: string
+  created_at: string
+  deep_link?: string
+  telegram_status?:
+    | 'pending'
+    | 'active'
+    | 'inactive'
+    | 'unsubscribed'
+    | 'blocked'
+    | 'already_activated'
+    | 'bot_not_configured'
+}
+
+/** DELETE /subscriptions response */
+export interface UnsubscribeResponse {
+  deleted: boolean
+}
+
+/** GET /subscriptions response item */
+export interface Subscription {
+  user_id: string
+  notification_type: string
+  channel: string
+  channel_address: string
+  created_at: string
+  telegram_status?:
+    | 'pending'
+    | 'active'
+    | 'inactive'
+    | 'unsubscribed'
+    | 'blocked'
+}
+
+/** GET /notifications query (public, no auth required) */
+export interface ListNotificationsQuery {
+  user_id: string
+  notification_type?: string
+  priority?: string
+  inner_type?: string
+  limit?: number
+  offset?: number
+}
+
+/** GET /notifications response item */
+export interface Notification {
+  id: number
+  notification_type: string
+  inner_type: string
+  user_id: string
+  priority: string
+  message: string
+  data: Record<string, unknown>
+  notification_id: string | null
+  relevance_until: string
+  created_at: string
+}
+
+export class NetworkError extends Error {
+  constructor(
+    message: string,
+    public readonly status?: number,
+    public readonly response?: unknown,
+  ) {
+    super(message)
+    this.name = 'NetworkError'
+  }
+}