@pear-protocol/types 2.20.0 → 2.22.0

package/dist/notification/entities.js

@@ -1,274 +0,0 @@
-import { z } from 'zod';
-import { Side, UnsignedDecimalString } from '../common/schema';
-import { Connector } from '../connector';
-import { TpSlBracketType } from '../trigger/common';
-
-const NotificationCategory = z.enum([
-  "TAKE_PROFIT_HIT",
-  "STOP_LOSS_HIT",
-  "TRIGGER_ORDER_HIT",
-  "TAKE_PROFIT_FAILED",
-  "STOP_LOSS_FAILED",
-  "TRIGGER_ORDER_FAILED",
-  "ATTACHED_TRIGGER_DISCARDED",
-  "AUTO_REBALANCE_EXECUTED",
-  "AUTO_REBALANCE_FAILED",
-  "AUTO_REBALANCE_PAUSED",
-  "TRIGGER_TWAP_STARTED",
-  "TRIGGER_TWAP_SKIPPED",
-  "TRIGGER_TWAP_FAILED",
-  "TRIGGER_TWAP_POSITION_CHANGED",
-  "TRIGGER_CANCELLED_MIS_SCALED",
-  "COPY_PLACED",
-  "COPY_FAILED",
-  "COPY_SUBSCRIPTION_STOPPED",
-  "COPY_LEVERAGE_NOT_APPLIED",
-  "POSITION_LIQUIDATION"
-]);
-const NotificationMetric = z.enum([
-  "ratio",
-  "price",
-  "weighted_ratio",
-  "notional",
-  "upnl",
-  "upnl_bps",
-  "ratio_trailing",
-  "price_trailing",
-  "weighted_ratio_trailing",
-  "notional_trailing",
-  "upnl_trailing",
-  "upnl_bps_trailing",
-  "funding_rate",
-  "prediction_market",
-  "btc_dominance"
-]);
-const TriggerNotificationEnrichment = {
-  metric: NotificationMetric.optional(),
-  level: z.number().optional(),
-  reason: z.string().max(255).optional()
-};
-const TriggerNotificationLeg = z.object({
-  id: z.string().min(1),
-  symbol: z.string().min(1),
-  side: Side
-});
-const PositionLegParameters = z.object({
-  legs: z.array(TriggerNotificationLeg)
-});
-const TakeProfitNotificationParameters = PositionLegParameters.safeExtend({
-  type: z.literal("take_profit"),
-  triggerId: z.uuid(),
-  positionId: z.uuid(),
-  connector: Connector,
-  ...TriggerNotificationEnrichment,
-  // User-facing bracket semantics; absent when a legacy trigger's intent is unknown.
-  semanticBracketType: TpSlBracketType.optional()
-});
-const StopLossNotificationParameters = PositionLegParameters.safeExtend({
-  type: z.literal("stop_loss"),
-  triggerId: z.uuid(),
-  positionId: z.uuid(),
-  connector: Connector,
-  ...TriggerNotificationEnrichment,
-  // User-facing bracket semantics; absent when a legacy trigger's intent is unknown.
-  semanticBracketType: TpSlBracketType.optional()
-});
-const TriggerOrderNotificationParameters = PositionLegParameters.safeExtend({
-  type: z.literal("trigger_order"),
-  triggerId: z.uuid(),
-  positionId: z.uuid(),
-  connector: Connector,
-  ...TriggerNotificationEnrichment
-});
-const DefaultTriggerNotificationParameters = PositionLegParameters.safeExtend({
-  type: z.literal("default_trigger"),
-  triggerId: z.uuid(),
-  connector: Connector,
-  ...TriggerNotificationEnrichment
-});
-const AttachedTriggerDiscardedNotificationParameters = PositionLegParameters.safeExtend({
-  type: z.literal("attached_trigger_discarded"),
-  positionId: z.uuid(),
-  positionKey: z.string().min(1),
-  connector: Connector,
-  discarded: z.array(z.object({
-    bracketType: z.enum([
-      "STOP_LOSS",
-      "TAKE_PROFIT"
-    ]),
-    metric: NotificationMetric,
-    level: z.number().optional(),
-    reason: z.enum([
-      "TRIGGER_LIMIT",
-      "TRAILING_ALREADY_EXISTS"
-    ])
-  })).min(1),
-  activeTriggerLimit: z.number().int().positive()
-});
-const AutoRebalanceLeg = z.object({
-  id: z.string().min(1),
-  symbol: z.string().min(1),
-  side: Side
-});
-const AutoRebalanceAnchor = {
-  configId: z.uuid(),
-  positionId: z.uuid(),
-  positionKey: z.string().min(1),
-  connector: Connector,
-  weightSource: z.enum([
-    "INITIAL_WEIGHT",
-    "LIVE_BETA"
-  ])
-};
-const AutoRebalanceRunLegs = z.array(AutoRebalanceLeg.safeExtend({
-  currentWeight: z.number(),
-  targetWeight: z.number()
-}));
-const AutoRebalanceExecutedNotificationParameters = z.object({
-  type: z.literal("auto_rebalance_executed"),
-  ...AutoRebalanceAnchor,
-  legs: AutoRebalanceRunLegs,
-  driftPct: z.number(),
-  notionalUsd: z.number()
-});
-const AutoRebalanceFailedNotificationParameters = z.object({
-  type: z.literal("auto_rebalance_failed"),
-  ...AutoRebalanceAnchor,
-  legs: AutoRebalanceRunLegs,
-  driftPct: z.number(),
-  reason: z.string().max(255)
-});
-const AutoRebalancePausedNotificationParameters = z.object({
-  type: z.literal("auto_rebalance_paused"),
-  ...AutoRebalanceAnchor,
-  legs: z.array(AutoRebalanceLeg),
-  pausedReason: z.enum([
-    "POSITION_CHANGED",
-    "REPEATED_FAILURES",
-    "INVALID_LIVE_BETA_EXPOSURE"
-  ])
-});
-const TriggerCancelledMisScaledNotificationParameters = z.object({
-  type: z.literal("trigger_cancelled_mis_scaled"),
-  triggerId: z.uuid(),
-  positionKey: z.string().min(1),
-  storedBps: z.number(),
-  readingMarginPct: z.number()
-});
-const TriggerTWAPNotificationAnchor = PositionLegParameters.safeExtend({
-  triggerId: z.uuid(),
-  positionId: z.uuid(),
-  connector: Connector
-});
-const TriggerTWAPStartedNotificationParameters = TriggerTWAPNotificationAnchor.safeExtend({
-  type: z.literal("trigger_twap_started"),
-  scheduleId: z.uuid()
-});
-const TriggerTWAPSkippedNotificationParameters = TriggerTWAPNotificationAnchor.safeExtend({
-  type: z.literal("trigger_twap_skipped"),
-  reason: z.string().min(1).max(255)
-});
-const TriggerTWAPFailedNotificationParameters = TriggerTWAPNotificationAnchor.safeExtend({
-  type: z.literal("trigger_twap_failed"),
-  scheduleId: z.uuid().optional(),
-  reason: z.string().min(1).max(255)
-});
-const TriggerTWAPPositionChangedNotificationParameters = TriggerTWAPNotificationAnchor.safeExtend({
-  type: z.literal("trigger_twap_position_changed"),
-  scheduleId: z.uuid(),
-  reason: z.string().min(1).max(255)
-});
-const CopyPlacedNotificationParameters = z.object({
-  type: z.literal("copy_placed"),
-  subscriptionId: z.uuid(),
-  activityId: z.uuid(),
-  resource: z.object({
-    kind: z.literal("POSITION"),
-    id: z.uuid()
-  }),
-  leaderTradeAccountId: z.uuid()
-});
-const CopyFailedNotificationParameters = z.object({
-  type: z.literal("copy_failed"),
-  subscriptionId: z.uuid(),
-  activityId: z.uuid(),
-  reason: z.string().max(255)
-});
-const CopySubscriptionStoppedNotificationParameters = z.object({
-  type: z.literal("copy_subscription_stopped"),
-  subscriptionId: z.uuid(),
-  reason: z.enum([
-    "REPEATED_FAILURES",
-    "MANUAL_TRADE",
-    "EXTERNAL_POSITION_DETECTED",
-    "LEADER_EXTERNAL_ACTIVITY"
-  ])
-});
-const CopyLeverageNotAppliedNotificationParameters = z.object({
-  type: z.literal("copy_leverage_not_applied"),
-  subscriptionId: z.uuid(),
-  activityId: z.uuid()
-});
-const PositionLiquidationNotificationParameters = z.object({
-  type: z.literal("position_liquidation"),
-  positionId: z.uuid(),
-  tradeAccountId: z.uuid(),
-  connector: Connector,
-  exchangeFillId: z.string().min(1),
-  occurredAt: z.number().int().nonnegative(),
-  leg: TriggerNotificationLeg,
-  quantity: UnsignedDecimalString,
-  price: UnsignedDecimalString,
-  outcome: z.enum([
-    "CLOSED",
-    "REDUCED"
-  ])
-});
-const NotificationParameters = z.discriminatedUnion("type", [
-  PositionLiquidationNotificationParameters,
-  TakeProfitNotificationParameters,
-  StopLossNotificationParameters,
-  TriggerOrderNotificationParameters,
-  DefaultTriggerNotificationParameters,
-  AttachedTriggerDiscardedNotificationParameters,
-  AutoRebalanceExecutedNotificationParameters,
-  AutoRebalanceFailedNotificationParameters,
-  AutoRebalancePausedNotificationParameters,
-  TriggerTWAPStartedNotificationParameters,
-  TriggerTWAPSkippedNotificationParameters,
-  TriggerTWAPFailedNotificationParameters,
-  TriggerTWAPPositionChangedNotificationParameters,
-  TriggerCancelledMisScaledNotificationParameters,
-  CopyPlacedNotificationParameters,
-  CopyFailedNotificationParameters,
-  CopySubscriptionStoppedNotificationParameters,
-  CopyLeverageNotAppliedNotificationParameters
-]);
-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, NotificationMetric, NotificationParameters };

package/dist/notification/index.js

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

package/dist/notification/payloads.js

@@ -1,15 +0,0 @@
-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.js

@@ -1,29 +0,0 @@
-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.js

@@ -1,20 +0,0 @@
-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/dist/order/entities.js

@@ -1,81 +0,0 @@
-import { z } from 'zod';
-import { UnsignedDecimalString, Side } from '../common/schema';
-import { Connector } from '../connector';
-import { InstrumentId } from '../instrument';
-
-const OrderStatus = z.enum([
-  "PENDING",
-  "PARTIAL",
-  "FILLED",
-  "CANCELLED",
-  "REJECTED"
-]);
-const BaseOrder = z.object({
-  /**
-  * Order UUID
-  */
-  id: z.uuid(),
-  /**
-  * Connector
-  */
-  connector: Connector,
-  /**
-  * Order status
-  */
-  status: OrderStatus,
-  /**
-  * Error message
-  */
-  error: z.string().optional(),
-  /**
-  * Venue-specific error code for the failure, when the venue provided one
-  */
-  errorCode: z.string().optional(),
-  /**
-  * Created at timestamp
-  */
-  createdAt: z.string(),
-  /**
-  * Updated at timestamp
-  */
-  updatedAt: z.string()
-});
-const MarketOrder = BaseOrder.extend({
-  /**
-  * Order type
-  */
-  type: z.literal("MARKET"),
-  /**
-  * Instrument ID
-  */
-  symbol: InstrumentId,
-  /**
-  * Side
-  */
-  side: Side,
-  /**
-  * Reduce only flag
-  */
-  reduceOnly: z.boolean(),
-  /**
-  * Contract quantity to trade
-  */
-  quantity: UnsignedDecimalString,
-  /**
-  * Price
-  */
-  price: UnsignedDecimalString,
-  /**
-  * Filled contract quantity
-  */
-  filledQuantity: UnsignedDecimalString,
-  /**
-  * Filled price
-  */
-  filledPrice: UnsignedDecimalString.optional()
-});
-const Order = z.discriminatedUnion("type", [
-  BaseOrder.extend(MarketOrder.shape)
-]);
-
-export { MarketOrder, Order, OrderStatus };

package/dist/order/index.js

@@ -1 +0,0 @@
-export * from './entities';

package/dist/portfolio/entities.js

@@ -1,77 +0,0 @@
-import { z } from 'zod';
-
-const NullableNumber = z.number().nullable();
-const PortfolioCashflowAmounts = z.object({
-  grossPnl: z.number(),
-  tradeFees: z.number(),
-  pearFees: z.number(),
-  netCashflow: z.number(),
-  funding: z.number(),
-  netCashflowWithFunding: z.number(),
-  undeterminedQuantityByAsset: z.record(z.string(), z.number())
-});
-const PortfolioCashflowSeriesPoint = PortfolioCashflowAmounts.extend({
-  periodStart: z.string(),
-  periodEnd: z.string()
-});
-const PortfolioCashflowIntervals = z.object({
-  oneDay: z.array(PortfolioCashflowSeriesPoint),
-  oneWeek: z.array(PortfolioCashflowSeriesPoint),
-  oneMonth: z.array(PortfolioCashflowSeriesPoint),
-  oneYear: z.array(PortfolioCashflowSeriesPoint),
-  all: z.array(PortfolioCashflowSeriesPoint)
-});
-const PortfolioVolumeAmounts = z.object({
-  total: z.number()
-});
-const PortfolioVolumeSeriesPoint = z.object({
-  periodStart: z.string(),
-  periodEnd: z.string(),
-  volume: z.number()
-});
-const PortfolioVolumeIntervals = z.object({
-  oneDay: z.array(PortfolioVolumeSeriesPoint),
-  oneWeek: z.array(PortfolioVolumeSeriesPoint),
-  oneMonth: z.array(PortfolioVolumeSeriesPoint),
-  oneYear: z.array(PortfolioVolumeSeriesPoint),
-  all: z.array(PortfolioVolumeSeriesPoint)
-});
-const PortfolioClosedPositionStats = z.object({
-  totalPositions: z.number(),
-  wins: z.number(),
-  losses: z.number(),
-  hitRate: NullableNumber,
-  profitFactor: NullableNumber,
-  avgWinSize: NullableNumber,
-  avgLossSize: NullableNumber,
-  netPnl: z.number(),
-  positionPnls: z.array(z.number()),
-  positionReturns: z.array(z.number())
-});
-const PortfolioPairBreakdown = z.object({
-  key: z.string(),
-  longAssets: z.array(z.string()),
-  shortAssets: z.array(z.string()),
-  positions: z.number(),
-  wins: z.number(),
-  losses: z.number(),
-  hitRate: NullableNumber,
-  profitFactor: NullableNumber,
-  expectancy: z.number(),
-  grossPnl: z.number(),
-  tradeFees: z.number(),
-  pearFees: z.number(),
-  netPnl: z.number(),
-  // Signed share of closed-position net PnL; null when the closed book is zero.
-  bookPercent: NullableNumber
-});
-const PortfolioOpenSnapshot = z.object({
-  openInterest: z.number(),
-  unrealizedPnl: z.number()
-});
-const PortfolioAnalyticsConfig = z.object({
-  startDate: z.string(),
-  endDate: z.string()
-});
-
-export { NullableNumber, PortfolioAnalyticsConfig, PortfolioCashflowAmounts, PortfolioCashflowIntervals, PortfolioCashflowSeriesPoint, PortfolioClosedPositionStats, PortfolioOpenSnapshot, PortfolioPairBreakdown, PortfolioVolumeAmounts, PortfolioVolumeIntervals, PortfolioVolumeSeriesPoint };

package/dist/portfolio/index.js

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

package/dist/portfolio/queries.js

@@ -1,34 +0,0 @@
-import { z } from 'zod';
-
-const PortfolioSource = z.enum([
-  "all",
-  "pear"
-]);
-const PortfolioQuery = z.object({
-  startDate: z.string().optional().describe("Inclusive portfolio range start."),
-  endDate: z.string().optional().describe("Exclusive portfolio range end."),
-  // "pear" excludes external imported fills from volume calculations.
-  source: PortfolioSource.optional().default("all")
-});
-const PortfolioAnalyticsInterval = z.enum([
-  "1d",
-  "1w",
-  "1m",
-  "1y",
-  "all"
-]);
-const PortfolioAnalyticsQuery = z.object({
-  startDate: z.string().optional().describe("Inclusive analytics range start."),
-  endDate: z.string().optional().describe("Exclusive analytics range end."),
-  interval: PortfolioAnalyticsInterval.optional(),
-  includeSeries: z.union([
-    z.boolean(),
-    z.enum([
-      "false",
-      "true"
-    ]).transform((value) => value === "true")
-  ]).optional(),
-  source: PortfolioSource.optional().default("all")
-});
-
-export { PortfolioAnalyticsInterval, PortfolioAnalyticsQuery, PortfolioQuery, PortfolioSource };

package/dist/portfolio/responses.js

@@ -1,33 +0,0 @@
-import { z } from 'zod';
-import { PortfolioOpenSnapshot, PortfolioClosedPositionStats, PortfolioVolumeAmounts, PortfolioVolumeIntervals, PortfolioCashflowAmounts, PortfolioCashflowIntervals, PortfolioAnalyticsConfig, PortfolioVolumeSeriesPoint, PortfolioPairBreakdown, PortfolioCashflowSeriesPoint } from './entities';
-
-const PortfolioResponse = z.object({
-  /** Historical accounting or the current open snapshot still uses provisional fills. */
-  hasProvisionalFills: z.boolean(),
-  realizedCashflow: PortfolioCashflowAmounts.extend({
-    fundingSynced: z.boolean(),
-    intervals: PortfolioCashflowIntervals.optional()
-  }),
-  closedPositionStats: PortfolioClosedPositionStats,
-  openSnapshot: PortfolioOpenSnapshot,
-  volume: PortfolioVolumeAmounts.extend({
-    intervals: PortfolioVolumeIntervals.optional()
-  })
-});
-const PortfolioAnalyticsResponse = z.object({
-  config: PortfolioAnalyticsConfig,
-  /** Historical accounting or the current open snapshot still uses provisional fills. */
-  hasProvisionalFills: z.boolean(),
-  realizedCashflow: PortfolioCashflowAmounts.extend({
-    fundingSynced: z.boolean(),
-    series: z.array(PortfolioCashflowSeriesPoint).optional()
-  }),
-  closedPositionStats: PortfolioClosedPositionStats,
-  pairBreakdown: z.array(PortfolioPairBreakdown),
-  openSnapshot: PortfolioOpenSnapshot,
-  volume: PortfolioVolumeAmounts.extend({
-    series: z.array(PortfolioVolumeSeriesPoint).optional()
-  })
-});
-
-export { PortfolioAnalyticsResponse, PortfolioResponse };