@pear-protocol/types 2.14.0 → 2.15.0

package/dist/position/entities.d.ts

@@ -83,6 +83,8 @@ export declare const Position: z.ZodObject<{
         PEAR: "PEAR";
         EXTERNAL: "EXTERNAL";
     }>;
+    copySubscriptionId: z.ZodOptional<z.ZodUUID>;
+    isCopying: z.ZodOptional<z.ZodBoolean>;
     exposure: z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>>;
     unstableHistoricalData: z.ZodBoolean;
     totalFundingPayment: z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>>;
@@ -249,6 +251,8 @@ export declare const ClosedPosition: z.ZodObject<{
         PEAR: "PEAR";
         EXTERNAL: "EXTERNAL";
     }>;
+    copySubscriptionId: z.ZodOptional<z.ZodUUID>;
+    isCopying: z.ZodOptional<z.ZodLiteral<false>>;
     grossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     netPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     totalFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
@@ -382,6 +386,8 @@ export declare const OpenPosition: z.ZodObject<{
         PEAR: "PEAR";
         EXTERNAL: "EXTERNAL";
     }>;
+    copySubscriptionId: z.ZodOptional<z.ZodUUID>;
+    isCopying: z.ZodOptional<z.ZodBoolean>;
     realizedGrossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     volume: z.ZodString;
     grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;

package/dist/position/entities.js

@@ -43,6 +43,10 @@ const Position = z.object({
   */
   closedReason: PositionClosedReason.nullable().optional(),
   origin: PositionOrigin,
+  /** The subscription that opened this position, retained after copying stops. */
+  copySubscriptionId: z.uuid().optional(),
+  /** Whether the existing copy eligibility rules still allow this position to follow its leader. */
+  isCopying: z.boolean().optional(),
   /**
   * Position exposure
   */
@@ -184,6 +188,10 @@ const ClosedPosition = z.object({
   closedAt: z.string(),
   closedReason: PositionClosedReason.optional(),
   origin: PositionOrigin,
+  /** The subscription that opened this position, retained after its lifecycle closes. */
+  copySubscriptionId: z.uuid().optional(),
+  /** A closed copy position no longer follows its leader, regardless of subscription status. */
+  isCopying: z.literal(false).optional(),
   grossPnl: SignedDecimalString,
   netPnl: SignedDecimalString,
   totalFees: SignedDecimalString,
@@ -308,6 +316,10 @@ const OpenPosition = z.object({
   /** The position's last update, independent of the page cursor. */
   updatedAt: z.string(),
   origin: PositionOrigin,
+  /** The subscription that opened this position, retained after copying stops. */
+  copySubscriptionId: z.uuid().optional(),
+  /** Whether the existing copy eligibility rules still allow this position to follow its leader. */
+  isCopying: z.boolean().optional(),
   /**
   * Realized PnL booked so far, before fees. Qualified because the position is still
   * live, and revisable while it is — see netCashflow on reconciliation.

package/dist/position/responses.d.ts

@@ -28,6 +28,8 @@ export declare const PositionListResponse: z.ZodObject<{
             PEAR: "PEAR";
             EXTERNAL: "EXTERNAL";
         }>;
+        copySubscriptionId: z.ZodOptional<z.ZodUUID>;
+        isCopying: z.ZodOptional<z.ZodBoolean>;
         exposure: z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>>;
         unstableHistoricalData: z.ZodBoolean;
         totalFundingPayment: z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>>;
@@ -119,6 +121,8 @@ export declare const ClosedPositionListResponse: z.ZodObject<{
             PEAR: "PEAR";
             EXTERNAL: "EXTERNAL";
         }>;
+        copySubscriptionId: z.ZodOptional<z.ZodUUID>;
+        isCopying: z.ZodOptional<z.ZodLiteral<false>>;
         grossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         netPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         totalFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
@@ -223,6 +227,8 @@ export declare const OpenPositionListResponse: z.ZodObject<{
             PEAR: "PEAR";
             EXTERNAL: "EXTERNAL";
         }>;
+        copySubscriptionId: z.ZodOptional<z.ZodUUID>;
+        isCopying: z.ZodOptional<z.ZodBoolean>;
         realizedGrossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         volume: z.ZodString;
         grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;

package/dist/traders/public.d.ts

@@ -4,6 +4,12 @@ export declare const PublicTraderParams: z.ZodObject<{
     tradeAccountId: z.ZodUUID;
 }, z.core.$strip>;
 export type PublicTraderParams = z.output<typeof PublicTraderParams>;
+/** Follower context requires authentication and an owned account selected by the standard header. */
+export declare const PublicTraderQuery: z.ZodObject<{
+    includeCopyState: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodCodec<z.ZodString, z.ZodBoolean>]>>>;
+}, z.core.$strip>;
+export type PublicTraderQueryInput = z.input<typeof PublicTraderQuery>;
+export type PublicTraderQuery = z.output<typeof PublicTraderQuery>;
 /** Public closed-history filters; refuse steps and every unsupported private option. */
 export declare const PublicTraderClosedPositionsParams: z.ZodObject<{
     limit: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<number>>>;
@@ -14,6 +20,15 @@ export declare const PublicTraderClosedPositionsParams: z.ZodObject<{
 }, z.core.$strict>;
 export type PublicTraderClosedPositionsParamsInput = z.input<typeof PublicTraderClosedPositionsParams>;
 export type PublicTraderClosedPositionsParams = z.output<typeof PublicTraderClosedPositionsParams>;
+/** A selected follower's result for one leader position. */
+export declare const ViewerCopyStatus: z.ZodEnum<{
+    COPIED: "COPIED";
+    PARTIAL: "PARTIAL";
+    PENDING: "PENDING";
+    NOT_COPIED: "NOT_COPIED";
+    UNKNOWN: "UNKNOWN";
+}>;
+export type ViewerCopyStatus = z.output<typeof ViewerCopyStatus>;
 export declare const PublicOpenPosition: z.ZodObject<{
     status: z.ZodLiteral<"OPEN">;
     connector: z.ZodEnum<{
@@ -26,9 +41,18 @@ export declare const PublicOpenPosition: z.ZodObject<{
     }>;
     updatedAt: z.ZodString;
     positionId: z.ZodUUID;
+    copySubscriptionId: z.ZodOptional<z.ZodUUID>;
     openedAt: z.ZodString;
     realizedGrossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     netCashflow: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    copyStatus: z.ZodOptional<z.ZodEnum<{
+        COPIED: "COPIED";
+        PARTIAL: "PARTIAL";
+        PENDING: "PENDING";
+        NOT_COPIED: "NOT_COPIED";
+        UNKNOWN: "UNKNOWN";
+    }>>;
+    copyReason: z.ZodOptional<z.ZodString>;
     legs: z.ZodArray<z.ZodObject<{
         side: z.ZodEnum<{
             LONG: "LONG";
@@ -2598,9 +2622,18 @@ export declare const PublicTraderResponse: z.ZodObject<{
         }>;
         updatedAt: z.ZodString;
         positionId: z.ZodUUID;
+        copySubscriptionId: z.ZodOptional<z.ZodUUID>;
         openedAt: z.ZodString;
         realizedGrossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         netCashflow: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        copyStatus: z.ZodOptional<z.ZodEnum<{
+            COPIED: "COPIED";
+            PARTIAL: "PARTIAL";
+            PENDING: "PENDING";
+            NOT_COPIED: "NOT_COPIED";
+            UNKNOWN: "UNKNOWN";
+        }>>;
+        copyReason: z.ZodOptional<z.ZodString>;
         legs: z.ZodArray<z.ZodObject<{
             side: z.ZodEnum<{
                 LONG: "LONG";

package/dist/traders/public.js

@@ -11,6 +11,21 @@ import { TriggerMarketOpen, TriggerMarketAdjust, TriggerMarketClose, TriggerTWAP
 const PublicTraderParams = z.object({
   tradeAccountId: z.uuid()
 });
+const PublicTraderQuery = z.object({
+  /** Accept exact HTTP boolean strings without treating the string "false" as true. */
+  includeCopyState: z.union([
+    z.boolean(),
+    z.stringbool({
+      truthy: [
+        "true"
+      ],
+      falsy: [
+        "false"
+      ],
+      case: "sensitive"
+    })
+  ]).optional().default(false)
+});
 const PublicTraderClosedPositionsParams = z.object({
   limit: ClosedPositionListParams.shape.limit,
   cursor: ClosedPositionListParams.shape.cursor,
@@ -18,15 +33,27 @@ const PublicTraderClosedPositionsParams = z.object({
   endDate: ClosedPositionListParams.shape.endDate,
   positionId: ClosedPositionListParams.shape.positionId
 }).strict();
+const ViewerCopyStatus = z.enum([
+  "COPIED",
+  "PARTIAL",
+  "NOT_COPIED",
+  "PENDING",
+  "UNKNOWN"
+]);
 const PublicOpenPosition = OpenPosition.pick({
   positionId: true,
   status: true,
   connector: true,
   openedAt: true,
   updatedAt: true,
+  copySubscriptionId: true,
   realizedGrossPnl: true,
   netCashflow: true
 }).extend({
+  /** The selected follower's result for this leader position; absent without viewer context. */
+  copyStatus: ViewerCopyStatus.optional(),
+  /** The recorded attempt, exclusion, or lifecycle reason for this follower's result. */
+  copyReason: z.string().optional(),
   legs: z.array(OpenPositionLeg.pick({
     asset: true,
     side: true,
@@ -163,4 +190,4 @@ const PublicTraderResponse = z.object({
   ladders: z.array(PublicLadder)
 });
 
-export { PublicClosedPosition, PublicLadder, PublicOpenPosition, PublicSchedule, PublicTraderClosedPositionsParams, PublicTraderClosedPositionsResponse, PublicTraderParams, PublicTraderResponse, PublicTrigger };
+export { PublicClosedPosition, PublicLadder, PublicOpenPosition, PublicSchedule, PublicTraderClosedPositionsParams, PublicTraderClosedPositionsResponse, PublicTraderParams, PublicTraderQuery, PublicTraderResponse, PublicTrigger, ViewerCopyStatus };

package/package.json

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