@pear-protocol/types 1.0.0 → 1.1.0

package/dist/bundle.d.ts

@@ -10,6 +10,7 @@ export * from './instrument-precision';
 export * from './leverage';
 export * from './market';
 export * from './misc';
+export * from './notification';
 export * from './order';
 export * from './portfolio';
 export * from './position';

package/dist/bundle.js

@@ -10,6 +10,7 @@ export * from './instrument-precision';
 export * from './leverage';
 export * from './market';
 export * from './misc';
+export * from './notification';
 export * from './order';
 export * from './portfolio';
 export * from './position';

package/dist/notification/entities.d.ts

@@ -0,0 +1,108 @@
+import { z } from 'zod';
+export declare const NotificationCategory: z.ZodEnum<{
+    TAKE_PROFIT_HIT: "TAKE_PROFIT_HIT";
+    STOP_LOSS_HIT: "STOP_LOSS_HIT";
+    TRIGGER_ORDER_HIT: "TRIGGER_ORDER_HIT";
+}>;
+export type NotificationCategory = z.infer<typeof NotificationCategory>;
+export declare const NotificationParameters: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"take_profit">;
+    triggerId: z.ZodUUID;
+    positionId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"stop_loss">;
+    triggerId: z.ZodUUID;
+    positionId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"trigger_order">;
+    triggerId: z.ZodUUID;
+    positionId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"default_trigger">;
+    triggerId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+}, z.core.$strip>], "type">;
+export type NotificationParameters = z.output<typeof NotificationParameters>;
+export declare const Notification: z.ZodObject<{
+    id: z.ZodUUID;
+    category: z.ZodEnum<{
+        TAKE_PROFIT_HIT: "TAKE_PROFIT_HIT";
+        STOP_LOSS_HIT: "STOP_LOSS_HIT";
+        TRIGGER_ORDER_HIT: "TRIGGER_ORDER_HIT";
+    }>;
+    parameters: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"take_profit">;
+        triggerId: z.ZodUUID;
+        positionId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"stop_loss">;
+        triggerId: z.ZodUUID;
+        positionId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"trigger_order">;
+        triggerId: z.ZodUUID;
+        positionId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"default_trigger">;
+        triggerId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+    }, z.core.$strip>], "type">;
+    isRead: z.ZodBoolean;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type Notification = z.output<typeof Notification>;

package/dist/notification/entities.js

@@ -0,0 +1,61 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+
+const NotificationCategory = z.enum(["TAKE_PROFIT_HIT", "STOP_LOSS_HIT", "TRIGGER_ORDER_HIT"]);
+const TakeProfitNotificationParameters = z.object({
+  type: z.literal("take_profit"),
+  triggerId: z.uuid(),
+  positionId: z.uuid(),
+  connector: Connector
+});
+const StopLossNotificationParameters = z.object({
+  type: z.literal("stop_loss"),
+  triggerId: z.uuid(),
+  positionId: z.uuid(),
+  connector: Connector
+});
+const TriggerOrderNotificationParameters = z.object({
+  type: z.literal("trigger_order"),
+  triggerId: z.uuid(),
+  positionId: z.uuid(),
+  connector: Connector
+});
+const DefaultTriggerNotificationParameters = z.object({
+  type: z.literal("default_trigger"),
+  triggerId: z.uuid(),
+  connector: Connector
+});
+const NotificationParameters = z.discriminatedUnion("type", [
+  TakeProfitNotificationParameters,
+  StopLossNotificationParameters,
+  TriggerOrderNotificationParameters,
+  DefaultTriggerNotificationParameters
+]);
+const Notification = z.object({
+  /**
+   * Notification UUID
+   */
+  id: z.uuid(),
+  /**
+   * What kind of notification this is
+   */
+  category: NotificationCategory,
+  /**
+   * Category-specific display payload
+   */
+  parameters: NotificationParameters,
+  /**
+   * Whether the user has read it
+   */
+  isRead: z.boolean(),
+  /**
+   * Created at timestamp
+   */
+  createdAt: z.string(),
+  /**
+   * Updated at timestamp
+   */
+  updatedAt: z.string()
+});
+
+export { Notification, NotificationCategory, NotificationParameters };

package/dist/notification/index.d.ts

@@ -0,0 +1,4 @@
+export * from './entities';
+export * from './payloads';
+export * from './queries';
+export * from './responses';

package/dist/notification/index.js

@@ -0,0 +1,4 @@
+export * from './entities';
+export * from './payloads';
+export * from './queries';
+export * from './responses';

package/dist/notification/payloads.d.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+/**
+ * Mark notifications as read. Provide exactly one selector: a single `id`, or a
+ * `timestamp` (epoch ms) to mark every notification created at or before it.
+ */
+export declare const MarkNotificationsReadPayload: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodUUID;
+}, z.core.$strict>, z.ZodObject<{
+    timestamp: z.ZodCoercedNumber<number>;
+}, z.core.$strict>]>;
+export type MarkNotificationsReadPayloadInput = z.input<typeof MarkNotificationsReadPayload>;
+export type MarkNotificationsReadPayload = z.output<typeof MarkNotificationsReadPayload>;
+/**
+ * Mark a single notification unread again.
+ */
+export declare const MarkNotificationUnreadPayload: z.ZodObject<{
+    id: z.ZodUUID;
+}, z.core.$strict>;
+export type MarkNotificationUnreadPayloadInput = z.input<typeof MarkNotificationUnreadPayload>;
+export type MarkNotificationUnreadPayload = z.output<typeof MarkNotificationUnreadPayload>;

package/dist/notification/payloads.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+
+const MarkNotificationsReadPayload = z.union([
+  z.strictObject({ id: z.uuid() }),
+  z.strictObject({ timestamp: z.coerce.number().int().positive() })
+]);
+const MarkNotificationUnreadPayload = z.strictObject({ id: z.uuid() });
+
+export { MarkNotificationUnreadPayload, MarkNotificationsReadPayload };

package/dist/notification/queries.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const NotificationListParams: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<number>>>;
+    startDate: z.ZodOptional<z.ZodCoercedDate<Date>>;
+    endDate: z.ZodOptional<z.ZodCoercedDate<Date>>;
+    scope: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        all: "all";
+        read: "read";
+        unread: "unread";
+    }>>>;
+}, z.core.$strip>;
+export type NotificationListParamsInput = z.input<typeof NotificationListParams>;
+export type NotificationListParams = z.output<typeof NotificationListParams>;

package/dist/notification/queries.js

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+
+const NotificationListParams = z.object({
+  /**
+   * The maximum number of notifications to retrieve (newest first).
+   * Matches the V2 engine: max and default are both 100.
+   */
+  limit: z.coerce.number().int().positive().max(100).optional().default(100),
+  /**
+   * Only return notifications created at or after this date.
+   */
+  startDate: z.coerce.date().optional(),
+  /**
+   * Only return notifications created at or before this date.
+   */
+  endDate: z.coerce.date().optional(),
+  /**
+   * Filter by read state: `all` (default), only `read`, or only `unread`.
+   */
+  scope: z.enum(["all", "read", "unread"]).optional().default("all")
+}).refine((data) => !data.startDate || !data.endDate || data.startDate < data.endDate, {
+  message: "startDate must be before endDate"
+});
+
+export { NotificationListParams };

package/dist/notification/responses.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+export declare const NotificationListResponse: z.ZodObject<{
+    notifications: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        category: z.ZodEnum<{
+            TAKE_PROFIT_HIT: "TAKE_PROFIT_HIT";
+            STOP_LOSS_HIT: "STOP_LOSS_HIT";
+            TRIGGER_ORDER_HIT: "TRIGGER_ORDER_HIT";
+        }>;
+        parameters: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"take_profit">;
+            triggerId: z.ZodUUID;
+            positionId: z.ZodUUID;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binance: "binance";
+                bybit: "bybit";
+                okx: "okx";
+                lighter: "lighter";
+            }>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"stop_loss">;
+            triggerId: z.ZodUUID;
+            positionId: z.ZodUUID;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binance: "binance";
+                bybit: "bybit";
+                okx: "okx";
+                lighter: "lighter";
+            }>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"trigger_order">;
+            triggerId: z.ZodUUID;
+            positionId: z.ZodUUID;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binance: "binance";
+                bybit: "bybit";
+                okx: "okx";
+                lighter: "lighter";
+            }>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"default_trigger">;
+            triggerId: z.ZodUUID;
+            connector: z.ZodEnum<{
+                hyperliquid: "hyperliquid";
+                binance: "binance";
+                bybit: "bybit";
+                okx: "okx";
+                lighter: "lighter";
+            }>;
+        }, z.core.$strip>], "type">;
+        isRead: z.ZodBoolean;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type NotificationListResponse = z.output<typeof NotificationListResponse>;
+export declare const MarkNotificationsReadResponse: z.ZodObject<{
+    updated: z.ZodNumber;
+}, z.core.$strip>;
+export type MarkNotificationsReadResponse = z.output<typeof MarkNotificationsReadResponse>;
+export declare const MarkNotificationUnreadResponse: z.ZodObject<{
+    updated: z.ZodNumber;
+}, z.core.$strip>;
+export type MarkNotificationUnreadResponse = z.output<typeof MarkNotificationUnreadResponse>;

package/dist/notification/responses.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { Notification } from './entities';
+
+const NotificationListResponse = z.object({
+  notifications: z.array(Notification)
+});
+const MarkNotificationsReadResponse = z.object({
+  /**
+   * How many notifications were flipped from unread to read.
+   */
+  updated: z.number().int()
+});
+const MarkNotificationUnreadResponse = z.object({
+  /**
+   * How many notifications were flipped from read to unread.
+   */
+  updated: z.number().int()
+});
+
+export { MarkNotificationUnreadResponse, MarkNotificationsReadResponse, NotificationListResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/types",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Pear Protocol Types definitions",
   "private": false,
   "type": "module",