@pear-protocol/types 1.4.0 → 1.6.0

package/dist/rebalance/responses.d.ts

@@ -1,10 +1,87 @@
 import { z } from 'zod';
-export declare const RebalanceManuallyResponse: z.ZodObject<{
-    plan: z.ZodUnion<readonly [z.ZodObject<{
+export declare const RebalanceManualResponse: z.ZodObject<{
+    plan: z.ZodDiscriminatedUnion<[z.ZodObject<{
         outcome: z.ZodLiteral<"full_rebalance">;
     }, z.core.$strip>, z.ZodObject<{
-        outcome: z.ZodUnion<readonly [z.ZodLiteral<"partial_rebalance">, z.ZodLiteral<"no_rebalance">]>;
+        outcome: z.ZodLiteral<"partial_rebalance">;
         messages: z.ZodTuple<[z.ZodString], z.ZodString>;
-    }, z.core.$strip>]>;
+    }, z.core.$strip>, z.ZodObject<{
+        outcome: z.ZodLiteral<"no_rebalance">;
+        messages: z.ZodTuple<[z.ZodString], z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        outcome: z.ZodLiteral<"failed">;
+        messages: z.ZodTuple<[z.ZodString], z.ZodString>;
+    }, z.core.$strip>], "outcome">;
+}, z.core.$strip>;
+export type RebalanceManualResponse = z.output<typeof RebalanceManualResponse>;
+export declare const AutoRebalanceListResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodUnion<[z.ZodString, z.ZodUndefined]>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        positionId: z.ZodUUID;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            PAUSED: "PAUSED";
+        }>;
+        weightSource: z.ZodEnum<{
+            INITIAL_WEIGHT: "INITIAL_WEIGHT";
+            LIVE_BETA: "LIVE_BETA";
+        }>;
+        minimumDriftPct: z.ZodString;
+        timeframe: z.ZodOptional<z.ZodEnum<{
+            "1d": "1d";
+            "1h": "1h";
+            "4h": "4h";
+        }>>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type AutoRebalanceListResponse = z.output<typeof AutoRebalanceListResponse>;
+export declare const CreateAutoRebalanceResponse: z.ZodObject<{
+    config: z.ZodObject<{
+        id: z.ZodUUID;
+        positionId: z.ZodUUID;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            PAUSED: "PAUSED";
+        }>;
+        weightSource: z.ZodEnum<{
+            INITIAL_WEIGHT: "INITIAL_WEIGHT";
+            LIVE_BETA: "LIVE_BETA";
+        }>;
+        minimumDriftPct: z.ZodString;
+        timeframe: z.ZodOptional<z.ZodEnum<{
+            "1d": "1d";
+            "1h": "1h";
+            "4h": "4h";
+        }>>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type CreateAutoRebalanceResponse = z.output<typeof CreateAutoRebalanceResponse>;
+export declare const RebalanceEventListResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodUnion<[z.ZodString, z.ZodUndefined]>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        autoRebalanceConfigId: z.ZodUUID;
+        positionId: z.ZodUUID;
+        weightSource: z.ZodEnum<{
+            INITIAL_WEIGHT: "INITIAL_WEIGHT";
+            LIVE_BETA: "LIVE_BETA";
+        }>;
+        driftPct: z.ZodString;
+        currentWeights: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        targetWeights: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        status: z.ZodEnum<{
+            FAILED: "FAILED";
+            SUCCESS: "SUCCESS";
+        }>;
+        error: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
-export type RebalanceManuallyResponse = z.output<typeof RebalanceManuallyResponse>;
+export type RebalanceEventListResponse = z.output<typeof RebalanceEventListResponse>;

package/dist/rebalance/responses.js

@@ -1,15 +1,33 @@
 import { z } from 'zod';
+import { CursorResponse } from '../common';
+import { AutoRebalanceConfig, RebalanceEvent } from './entities';
 
-const RebalanceManuallyResponse = z.object({
-  plan: z.union([
+const RebalanceManualResponse = z.object({
+  plan: z.discriminatedUnion("outcome", [
     z.object({
       outcome: z.literal("full_rebalance")
     }),
     z.object({
-      outcome: z.union([z.literal("partial_rebalance"), z.literal("no_rebalance")]),
+      outcome: z.literal("partial_rebalance"),
+      messages: z.tuple([z.string()]).rest(z.string())
+    }),
+    z.object({
+      outcome: z.literal("no_rebalance"),
+      messages: z.tuple([z.string()]).rest(z.string())
+    }),
+    // `failed` only occurs on background runs (dispatch/cron); MANUAL execution errors throw and surface as HTTP errors instead.
+    z.object({
+      outcome: z.literal("failed"),
       messages: z.tuple([z.string()]).rest(z.string())
     })
   ])
 });
+const AutoRebalanceListResponse = CursorResponse.extend({
+  items: z.array(AutoRebalanceConfig)
+});
+const CreateAutoRebalanceResponse = z.object({ config: AutoRebalanceConfig });
+const RebalanceEventListResponse = CursorResponse.extend({
+  items: z.array(RebalanceEvent)
+});
 
-export { RebalanceManuallyResponse };
+export { AutoRebalanceListResponse, CreateAutoRebalanceResponse, RebalanceEventListResponse, RebalanceManualResponse };

package/dist/saved-baskets/entities.d.ts

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+export declare const SavedBasketLeg: z.ZodObject<{
+    symbol: z.ZodString;
+    side: z.ZodEnum<{
+        BUY: "BUY";
+        SELL: "SELL";
+    }>;
+    weight: z.ZodNumber;
+}, z.core.$strip>;
+export declare const SavedBasket: z.ZodObject<{
+    id: z.ZodUUID;
+    name: z.ZodString;
+    legs: z.ZodTuple<[z.ZodObject<{
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        weight: z.ZodNumber;
+    }, z.core.$strip>], z.ZodObject<{
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        weight: z.ZodNumber;
+    }, z.core.$strip>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type SavedBasketLeg = z.infer<typeof SavedBasketLeg>;
+export type SavedBasket = z.infer<typeof SavedBasket>;

package/dist/saved-baskets/entities.js

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { Side, AssetWeight } from '../common/schema';
+import { InstrumentId } from '../instrument';
+
+const SavedBasketLeg = z.object({
+  symbol: InstrumentId,
+  side: Side,
+  weight: AssetWeight.describe("Share of total gross notional as a fraction (legs sum to 1)")
+});
+const SavedBasket = z.object({
+  id: z.uuid(),
+  name: z.string(),
+  legs: z.tuple([SavedBasketLeg]).rest(SavedBasketLeg),
+  createdAt: z.string(),
+  updatedAt: z.string()
+});
+
+export { SavedBasket, SavedBasketLeg };

package/dist/saved-baskets/index.d.ts

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

package/dist/saved-baskets/index.js

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

package/dist/saved-baskets/payloads.d.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+export declare const CreateSavedBasketPayload: z.ZodObject<{
+    name: z.ZodString;
+    legs: z.ZodTuple<[z.ZodObject<{
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        weight: z.ZodNumber;
+    }, z.core.$strip>], z.ZodObject<{
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        weight: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const UpdateSavedBasketPayload: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    legs: z.ZodOptional<z.ZodTuple<[z.ZodObject<{
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        weight: z.ZodNumber;
+    }, z.core.$strip>], z.ZodObject<{
+        symbol: z.ZodString;
+        side: z.ZodEnum<{
+            BUY: "BUY";
+            SELL: "SELL";
+        }>;
+        weight: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type CreateSavedBasketPayload = z.infer<typeof CreateSavedBasketPayload>;
+export type UpdateSavedBasketPayload = z.infer<typeof UpdateSavedBasketPayload>;

package/dist/saved-baskets/payloads.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { RefineUniqueSymbols, RefineWeightingSum } from '../common/refinement';
+import { SavedBasketLeg } from './entities';
+
+const SavedBasketName = z.string().trim().min(1, "Name is required").max(48).describe("Display name, unique per trade account (case-insensitive)");
+const SavedBasketLegs = z.tuple([SavedBasketLeg]).rest(SavedBasketLeg).superRefine(RefineUniqueSymbols).superRefine(RefineWeightingSum).refine((value) => value.length <= 20, "Basket must have at most 20 legs").describe("At least one leg, up to 20");
+const CreateSavedBasketPayload = z.object({
+  name: SavedBasketName,
+  legs: SavedBasketLegs
+}).describe("Save the current basket under a name");
+const UpdateSavedBasketPayload = z.object({
+  name: SavedBasketName.optional(),
+  legs: SavedBasketLegs.optional()
+}).refine((value) => value.name !== void 0 || value.legs !== void 0, "Provide a name or legs to update").describe("Rename a saved basket and/or replace its legs");
+
+export { CreateSavedBasketPayload, UpdateSavedBasketPayload };

package/dist/saved-baskets/responses.d.ts

@@ -0,0 +1,73 @@
+import { z } from 'zod';
+export declare const SavedBasketListResponse: z.ZodObject<{
+    baskets: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        name: z.ZodString;
+        legs: z.ZodTuple<[z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            weight: z.ZodNumber;
+        }, z.core.$strip>], z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            weight: z.ZodNumber;
+        }, z.core.$strip>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SavedBasketListResponse = z.output<typeof SavedBasketListResponse>;
+export declare const CreateSavedBasketResponse: z.ZodObject<{
+    basket: z.ZodObject<{
+        id: z.ZodUUID;
+        name: z.ZodString;
+        legs: z.ZodTuple<[z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            weight: z.ZodNumber;
+        }, z.core.$strip>], z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            weight: z.ZodNumber;
+        }, z.core.$strip>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type CreateSavedBasketResponse = z.output<typeof CreateSavedBasketResponse>;
+export declare const UpdateSavedBasketResponse: z.ZodObject<{
+    basket: z.ZodObject<{
+        id: z.ZodUUID;
+        name: z.ZodString;
+        legs: z.ZodTuple<[z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            weight: z.ZodNumber;
+        }, z.core.$strip>], z.ZodObject<{
+            symbol: z.ZodString;
+            side: z.ZodEnum<{
+                BUY: "BUY";
+                SELL: "SELL";
+            }>;
+            weight: z.ZodNumber;
+        }, z.core.$strip>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type UpdateSavedBasketResponse = z.output<typeof UpdateSavedBasketResponse>;

package/dist/saved-baskets/responses.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { SavedBasket } from './entities';
+
+const SavedBasketListResponse = z.object({
+  baskets: z.array(SavedBasket)
+});
+const CreateSavedBasketResponse = z.object({
+  basket: SavedBasket
+});
+const UpdateSavedBasketResponse = z.object({
+  basket: SavedBasket
+});
+
+export { CreateSavedBasketResponse, SavedBasketListResponse, UpdateSavedBasketResponse };

package/dist/schedule/entities.d.ts

@@ -114,6 +114,7 @@ declare const BaseSchedule: z.ZodObject<{
         }>;
         reduceOnly: z.ZodBoolean;
         isExternal: z.ZodBoolean;
+        synthetic: z.ZodBoolean;
         quantity: z.ZodString;
         price: z.ZodString;
         usd: z.ZodString;
@@ -183,6 +184,7 @@ export declare const TWAPOpen: z.ZodObject<{
         }>;
         reduceOnly: z.ZodBoolean;
         isExternal: z.ZodBoolean;
+        synthetic: z.ZodBoolean;
         quantity: z.ZodString;
         price: z.ZodString;
         usd: z.ZodString;
@@ -269,6 +271,7 @@ export declare const TWAPClose: z.ZodObject<{
         }>;
         reduceOnly: z.ZodBoolean;
         isExternal: z.ZodBoolean;
+        synthetic: z.ZodBoolean;
         quantity: z.ZodString;
         price: z.ZodString;
         usd: z.ZodString;
@@ -347,6 +350,7 @@ export declare const Schedule: z.ZodDiscriminatedUnion<[z.ZodObject<{
         }>;
         reduceOnly: z.ZodBoolean;
         isExternal: z.ZodBoolean;
+        synthetic: z.ZodBoolean;
         quantity: z.ZodString;
         price: z.ZodString;
         usd: z.ZodString;
@@ -432,6 +436,7 @@ export declare const Schedule: z.ZodDiscriminatedUnion<[z.ZodObject<{
         }>;
         reduceOnly: z.ZodBoolean;
         isExternal: z.ZodBoolean;
+        synthetic: z.ZodBoolean;
         quantity: z.ZodString;
         price: z.ZodString;
         usd: z.ZodString;

package/dist/schedule/responses.d.ts

@@ -59,6 +59,7 @@ export declare const ScheduleListResponse: z.ZodObject<{
             }>;
             reduceOnly: z.ZodBoolean;
             isExternal: z.ZodBoolean;
+            synthetic: z.ZodBoolean;
             quantity: z.ZodString;
             price: z.ZodString;
             usd: z.ZodString;
@@ -144,6 +145,7 @@ export declare const ScheduleListResponse: z.ZodObject<{
             }>;
             reduceOnly: z.ZodBoolean;
             isExternal: z.ZodBoolean;
+            synthetic: z.ZodBoolean;
             quantity: z.ZodString;
             price: z.ZodString;
             usd: z.ZodString;
@@ -225,6 +227,7 @@ export declare const CreateScheduleResponse: z.ZodObject<{
             }>;
             reduceOnly: z.ZodBoolean;
             isExternal: z.ZodBoolean;
+            synthetic: z.ZodBoolean;
             quantity: z.ZodString;
             price: z.ZodString;
             usd: z.ZodString;
@@ -310,6 +313,7 @@ export declare const CreateScheduleResponse: z.ZodObject<{
             }>;
             reduceOnly: z.ZodBoolean;
             isExternal: z.ZodBoolean;
+            synthetic: z.ZodBoolean;
             quantity: z.ZodString;
             price: z.ZodString;
             usd: z.ZodString;