@pear-protocol/types 1.16.0 → 1.17.0

package/dist/position/responses.d.ts

@@ -79,3 +79,109 @@ export declare const OpenPositionLiteListResponse: z.ZodObject<{
 }, z.core.$strip>;
 export type OpenPositionLite = z.output<typeof OpenPositionLite>;
 export type OpenPositionLiteListResponse = z.output<typeof OpenPositionLiteListResponse>;
+/**
+ * A page of closed trades.
+ *
+ * A page may hold fewer than `limit` trades and still return a `nextCursor`: closed
+ * positions with no confirmed fills are skipped during composition, exactly as
+ * `/portfolio` skips them. Page until `nextCursor` is absent, never until a page
+ * comes back short — stopping early silently truncates history.
+ */
+export declare const ClosedPositionListResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodOptional<z.ZodString>;
+    trades: z.ZodArray<z.ZodObject<{
+        positionId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        openedAt: z.ZodString;
+        closedAt: z.ZodString;
+        closedReason: z.ZodOptional<z.ZodEnum<{
+            NETTED: "NETTED";
+            USER: "USER";
+            LIQUIDATED: "LIQUIDATED";
+        }>>;
+        origin: z.ZodEnum<{
+            PARTIAL: "PARTIAL";
+            PEAR: "PEAR";
+            EXTERNAL: "EXTERNAL";
+        }>;
+        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>>;
+        tradeFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        pearFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        totalFunding: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        entryNotional: z.ZodString;
+        exitNotional: z.ZodString;
+        exitNotionalComplete: z.ZodBoolean;
+        hasSyntheticFills: z.ZodBoolean;
+        unstableHistoricalData: z.ZodBoolean;
+        longAssets: z.ZodArray<z.ZodString>;
+        shortAssets: z.ZodArray<z.ZodString>;
+        legs: z.ZodArray<z.ZodObject<{
+            asset: z.ZodString;
+            side: z.ZodEnum<{
+                LONG: "LONG";
+                SHORT: "SHORT";
+            }>;
+            entryVwap: z.ZodOptional<z.ZodString>;
+            exitVwap: z.ZodOptional<z.ZodString>;
+            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>>;
+            tradeFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            pearFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            funding: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            entryNotional: z.ZodString;
+            exitQuantity: z.ZodString;
+            undeterminedSize: z.ZodString;
+        }, z.core.$strip>>;
+        steps: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            executionId: z.ZodOptional<z.ZodString>;
+            at: z.ZodString;
+            grossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            legs: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"INCREASE">;
+                asset: z.ZodString;
+                side: z.ZodEnum<{
+                    BUY: "BUY";
+                    SELL: "SELL";
+                }>;
+                quantity: z.ZodString;
+                price: z.ZodString;
+                tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+                pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"REDUCE">;
+                asset: z.ZodString;
+                side: z.ZodEnum<{
+                    BUY: "BUY";
+                    SELL: "SELL";
+                }>;
+                quantity: z.ZodString;
+                price: z.ZodString;
+                entryBasis: z.ZodString;
+                grossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+                tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+                pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"REDUCE_UNPRICED">;
+                asset: z.ZodString;
+                side: z.ZodEnum<{
+                    BUY: "BUY";
+                    SELL: "SELL";
+                }>;
+                quantity: z.ZodString;
+                tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+                pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            }, z.core.$strip>], "kind">>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ClosedPositionListResponse = z.output<typeof ClosedPositionListResponse>;

package/dist/position/responses.js

@@ -3,7 +3,7 @@ import { CursorResponse } from '../common';
 import { SignedDecimalString } from '../common/schema';
 import { Connector } from '../connector';
 import { InstrumentId } from '../instrument';
-import { Position, PositionOrigin } from './entities';
+import { Position, PositionOrigin, ClosedTrade } from './entities';
 
 const PositionListResponse = CursorResponse.extend({
   positions: z.array(Position)
@@ -20,5 +20,8 @@ const OpenPositionLite = z.object({
 const OpenPositionLiteListResponse = z.object({
   positions: z.array(OpenPositionLite)
 });
+const ClosedPositionListResponse = CursorResponse.extend({
+  trades: z.array(ClosedTrade)
+});
 
-export { OpenPositionLite, OpenPositionLiteListResponse, PositionListResponse };
+export { ClosedPositionListResponse, OpenPositionLite, OpenPositionLiteListResponse, PositionListResponse };

package/dist/rebalance/entities.d.ts

@@ -29,7 +29,20 @@ export declare const RebalanceEventStatus: z.ZodEnum<{
 export type RebalanceEventStatus = z.infer<typeof RebalanceEventStatus>;
 export declare const WeightMap: z.ZodRecord<z.ZodString, z.ZodNumber>;
 export type WeightMap = z.output<typeof WeightMap>;
-export declare const AutoRebalanceConfig: z.ZodObject<{
+export declare const AutoRebalanceBetaState: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    state: z.ZodLiteral<"PENDING">;
+}, z.core.$strip>, z.ZodObject<{
+    state: z.ZodLiteral<"BASELINED">;
+    impliedEntryBeta: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    state: z.ZodLiteral<"TRACKING">;
+    impliedEntryBeta: z.ZodString;
+    lastDerivedBeta: z.ZodString;
+    lastProcessedBetaTime: z.ZodISODateTime;
+    driftPct: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>], "state">;
+export type AutoRebalanceBetaState = z.output<typeof AutoRebalanceBetaState>;
+export declare const AutoRebalanceConfig: z.ZodDiscriminatedUnion<[z.ZodObject<{
     id: z.ZodUUID;
     positionId: z.ZodUUID;
     status: z.ZodEnum<{
@@ -42,19 +55,45 @@ export declare const AutoRebalanceConfig: z.ZodObject<{
         REPEATED_FAILURES: "REPEATED_FAILURES";
         INVALID_LIVE_BETA_EXPOSURE: "INVALID_LIVE_BETA_EXPOSURE";
     }>>;
-    weightSource: z.ZodEnum<{
-        INITIAL_WEIGHT: "INITIAL_WEIGHT";
-        LIVE_BETA: "LIVE_BETA";
+    minimumDriftPct: z.ZodString;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    weightSource: z.ZodLiteral<"INITIAL_WEIGHT">;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodUUID;
+    positionId: z.ZodUUID;
+    status: z.ZodEnum<{
+        ACTIVE: "ACTIVE";
+        PAUSED: "PAUSED";
     }>;
+    pausedReason: z.ZodOptional<z.ZodEnum<{
+        USER: "USER";
+        POSITION_CHANGED: "POSITION_CHANGED";
+        REPEATED_FAILURES: "REPEATED_FAILURES";
+        INVALID_LIVE_BETA_EXPOSURE: "INVALID_LIVE_BETA_EXPOSURE";
+    }>>;
     minimumDriftPct: z.ZodString;
-    timeframe: z.ZodOptional<z.ZodEnum<{
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    weightSource: z.ZodLiteral<"LIVE_BETA">;
+    timeframe: z.ZodEnum<{
         "1d": "1d";
         "1h": "1h";
         "4h": "4h";
-    }>>;
-    createdAt: z.ZodISODateTime;
-    updatedAt: z.ZodISODateTime;
-}, z.core.$strip>;
+    }>;
+    beta: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        state: z.ZodLiteral<"PENDING">;
+    }, z.core.$strip>, z.ZodObject<{
+        state: z.ZodLiteral<"BASELINED">;
+        impliedEntryBeta: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        state: z.ZodLiteral<"TRACKING">;
+        impliedEntryBeta: z.ZodString;
+        lastDerivedBeta: z.ZodString;
+        lastProcessedBetaTime: z.ZodISODateTime;
+        driftPct: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>], "state">;
+}, z.core.$strip>], "weightSource">;
 export type AutoRebalanceConfig = z.output<typeof AutoRebalanceConfig>;
 export declare const RebalanceEvent: z.ZodObject<{
     id: z.ZodUUID;

package/dist/rebalance/entities.js

@@ -13,17 +13,46 @@ const AutoRebalanceWeightSource = z.enum(["INITIAL_WEIGHT", "LIVE_BETA"]);
 const AutoRebalanceTimeframe = z.enum(["1h", "4h", "1d"]);
 const RebalanceEventStatus = z.enum(["SUCCESS", "FAILED"]);
 const WeightMap = z.record(InstrumentId, z.number());
-const AutoRebalanceConfig = z.object({
+const AutoRebalanceConfigBase = z.object({
   id: z.uuid(),
   positionId: z.uuid(),
   status: AutoRebalanceStatus,
   pausedReason: AutoRebalancePausedReason.optional(),
-  weightSource: AutoRebalanceWeightSource,
   minimumDriftPct: UnsignedDecimalString,
-  timeframe: AutoRebalanceTimeframe.optional(),
   createdAt: z.iso.datetime(),
   updatedAt: z.iso.datetime()
 });
+const AutoRebalanceBetaState = z.discriminatedUnion("state", [
+  z.object({ state: z.literal("PENDING") }),
+  z.object({
+    state: z.literal("BASELINED"),
+    // The frozen drift baseline: implied beta of the achieved leg split at entry, re-snapshotted after
+    // every rebalance.
+    impliedEntryBeta: UnsignedDecimalString
+  }),
+  z.object({
+    state: z.literal("TRACKING"),
+    // The frozen drift baseline: implied beta of the achieved leg split at entry, re-snapshotted after
+    // every rebalance.
+    impliedEntryBeta: UnsignedDecimalString,
+    // Kalman beta of the last candle this config processed — the moving side of the drift comparison.
+    lastDerivedBeta: UnsignedDecimalString,
+    // Bar time lastDerivedBeta was read at, so a client can judge how fresh that beta is.
+    lastProcessedBetaTime: z.iso.datetime(),
+    // How far lastDerivedBeta sits from impliedEntryBeta, as a fraction (0.05 = 5%) directly comparable
+    // to minimumDriftPct. Derived from the two betas above; absent on a degenerate (zero) baseline.
+    driftPct: UnsignedDecimalString.optional()
+  })
+]);
+const AutoRebalanceConfig = z.discriminatedUnion("weightSource", [
+  AutoRebalanceConfigBase.extend({ weightSource: z.literal("INITIAL_WEIGHT") }),
+  AutoRebalanceConfigBase.extend({
+    weightSource: z.literal("LIVE_BETA"),
+    // Stat-arb bar timeframe selecting which realtime candle feed drives the drift comparison.
+    timeframe: AutoRebalanceTimeframe,
+    beta: AutoRebalanceBetaState
+  })
+]);
 const RebalanceEvent = z.object({
   id: z.uuid(),
   autoRebalanceConfigId: z.uuid(),
@@ -37,4 +66,4 @@ const RebalanceEvent = z.object({
   createdAt: z.iso.datetime()
 });
 
-export { AutoRebalanceConfig, AutoRebalancePausedReason, AutoRebalanceStatus, AutoRebalanceTimeframe, AutoRebalanceWeightSource, RebalanceEvent, RebalanceEventStatus, WeightMap };
+export { AutoRebalanceBetaState, AutoRebalanceConfig, AutoRebalancePausedReason, AutoRebalanceStatus, AutoRebalanceTimeframe, AutoRebalanceWeightSource, RebalanceEvent, RebalanceEventStatus, WeightMap };

package/dist/rebalance/responses.d.ts

@@ -17,7 +17,7 @@ export type RebalanceManualResponse = z.output<typeof RebalanceManualResponse>;
 export declare const AutoRebalanceListResponse: z.ZodObject<{
     limit: z.ZodNumber;
     nextCursor: z.ZodOptional<z.ZodString>;
-    items: z.ZodArray<z.ZodObject<{
+    items: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
         id: z.ZodUUID;
         positionId: z.ZodUUID;
         status: z.ZodEnum<{
@@ -30,23 +30,49 @@ export declare const AutoRebalanceListResponse: z.ZodObject<{
             REPEATED_FAILURES: "REPEATED_FAILURES";
             INVALID_LIVE_BETA_EXPOSURE: "INVALID_LIVE_BETA_EXPOSURE";
         }>>;
-        weightSource: z.ZodEnum<{
-            INITIAL_WEIGHT: "INITIAL_WEIGHT";
-            LIVE_BETA: "LIVE_BETA";
+        minimumDriftPct: z.ZodString;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        weightSource: z.ZodLiteral<"INITIAL_WEIGHT">;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodUUID;
+        positionId: z.ZodUUID;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            PAUSED: "PAUSED";
         }>;
+        pausedReason: z.ZodOptional<z.ZodEnum<{
+            USER: "USER";
+            POSITION_CHANGED: "POSITION_CHANGED";
+            REPEATED_FAILURES: "REPEATED_FAILURES";
+            INVALID_LIVE_BETA_EXPOSURE: "INVALID_LIVE_BETA_EXPOSURE";
+        }>>;
         minimumDriftPct: z.ZodString;
-        timeframe: z.ZodOptional<z.ZodEnum<{
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        weightSource: z.ZodLiteral<"LIVE_BETA">;
+        timeframe: z.ZodEnum<{
             "1d": "1d";
             "1h": "1h";
             "4h": "4h";
-        }>>;
-        createdAt: z.ZodISODateTime;
-        updatedAt: z.ZodISODateTime;
-    }, z.core.$strip>>;
+        }>;
+        beta: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            state: z.ZodLiteral<"PENDING">;
+        }, z.core.$strip>, z.ZodObject<{
+            state: z.ZodLiteral<"BASELINED">;
+            impliedEntryBeta: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            state: z.ZodLiteral<"TRACKING">;
+            impliedEntryBeta: z.ZodString;
+            lastDerivedBeta: z.ZodString;
+            lastProcessedBetaTime: z.ZodISODateTime;
+            driftPct: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "state">;
+    }, z.core.$strip>], "weightSource">>;
 }, z.core.$strip>;
 export type AutoRebalanceListResponse = z.output<typeof AutoRebalanceListResponse>;
 export declare const CreateAutoRebalanceResponse: z.ZodObject<{
-    config: z.ZodObject<{
+    config: z.ZodDiscriminatedUnion<[z.ZodObject<{
         id: z.ZodUUID;
         positionId: z.ZodUUID;
         status: z.ZodEnum<{
@@ -59,19 +85,45 @@ export declare const CreateAutoRebalanceResponse: z.ZodObject<{
             REPEATED_FAILURES: "REPEATED_FAILURES";
             INVALID_LIVE_BETA_EXPOSURE: "INVALID_LIVE_BETA_EXPOSURE";
         }>>;
-        weightSource: z.ZodEnum<{
-            INITIAL_WEIGHT: "INITIAL_WEIGHT";
-            LIVE_BETA: "LIVE_BETA";
+        minimumDriftPct: z.ZodString;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        weightSource: z.ZodLiteral<"INITIAL_WEIGHT">;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodUUID;
+        positionId: z.ZodUUID;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            PAUSED: "PAUSED";
         }>;
+        pausedReason: z.ZodOptional<z.ZodEnum<{
+            USER: "USER";
+            POSITION_CHANGED: "POSITION_CHANGED";
+            REPEATED_FAILURES: "REPEATED_FAILURES";
+            INVALID_LIVE_BETA_EXPOSURE: "INVALID_LIVE_BETA_EXPOSURE";
+        }>>;
         minimumDriftPct: z.ZodString;
-        timeframe: z.ZodOptional<z.ZodEnum<{
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        weightSource: z.ZodLiteral<"LIVE_BETA">;
+        timeframe: z.ZodEnum<{
             "1d": "1d";
             "1h": "1h";
             "4h": "4h";
-        }>>;
-        createdAt: z.ZodISODateTime;
-        updatedAt: z.ZodISODateTime;
-    }, z.core.$strip>;
+        }>;
+        beta: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            state: z.ZodLiteral<"PENDING">;
+        }, z.core.$strip>, z.ZodObject<{
+            state: z.ZodLiteral<"BASELINED">;
+            impliedEntryBeta: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            state: z.ZodLiteral<"TRACKING">;
+            impliedEntryBeta: z.ZodString;
+            lastDerivedBeta: z.ZodString;
+            lastProcessedBetaTime: z.ZodISODateTime;
+            driftPct: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "state">;
+    }, z.core.$strip>], "weightSource">;
 }, z.core.$strip>;
 export type CreateAutoRebalanceResponse = z.output<typeof CreateAutoRebalanceResponse>;
 export declare const RebalanceEventListResponse: z.ZodObject<{

package/dist/statistics/queries.d.ts

@@ -14,6 +14,7 @@ export declare const VolumeStatisticsQueryParams: z.ZodObject<{
     }>;
     startDate: z.ZodOptional<z.ZodCoercedDate<Date>>;
     endDate: z.ZodDefault<z.ZodCoercedDate<Date>>;
+    clientId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type VolumeStatisticsQueryParamsInput = z.input<typeof VolumeStatisticsQueryParams>;
 export type VolumeStatisticsQueryParams = z.output<typeof VolumeStatisticsQueryParams>;
@@ -32,6 +33,7 @@ export declare const OiStatisticsQueryParams: z.ZodObject<{
     }>;
     startDate: z.ZodOptional<z.ZodCoercedDate<Date>>;
     endDate: z.ZodDefault<z.ZodCoercedDate<Date>>;
+    clientId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type OiStatisticsQueryParamsInput = z.input<typeof OiStatisticsQueryParams>;
 export type OiStatisticsQueryParams = z.output<typeof OiStatisticsQueryParams>;
@@ -47,8 +49,8 @@ export declare const StatisticsTotalsQueryParams: z.ZodObject<{
 export type StatisticsTotalsQueryParamsInput = z.input<typeof StatisticsTotalsQueryParams>;
 export type StatisticsTotalsQueryParams = z.output<typeof StatisticsTotalsQueryParams>;
 export declare const LeaderboardSortBy: z.ZodEnum<{
-    volume: "volume";
     trades: "trades";
+    volume: "volume";
     totalNetPnl: "totalNetPnl";
 }>;
 export type LeaderboardSortBy = z.infer<typeof LeaderboardSortBy>;
@@ -64,8 +66,8 @@ export declare const LeaderboardQueryParams: z.ZodObject<{
     }>>>>;
     asset: z.ZodOptional<z.ZodPipe<z.ZodTransform<string[] | (string[] & any[]) | undefined, string[]>, z.ZodArray<z.ZodString>>>;
     sortBy: z.ZodDefault<z.ZodEnum<{
-        volume: "volume";
         trades: "trades";
+        volume: "volume";
         totalNetPnl: "totalNetPnl";
     }>>;
     startDate: z.ZodOptional<z.ZodPipe<z.ZodCoercedNumber<number>, z.ZodTransform<Date, number>>>;

package/dist/statistics/queries.js

@@ -6,7 +6,10 @@ const VolumeStatisticsQueryParams = z.object({
   connector: Connector,
   resolution: z.enum(["1h", "4h", "24h"]),
   startDate: z.coerce.date().optional(),
-  endDate: z.coerce.date().default(() => /* @__PURE__ */ new Date())
+  endDate: z.coerce.date().default(() => /* @__PURE__ */ new Date()),
+  // Per-client scope; absent serves the global series. The literal 'other'
+  // selects the unattributed (NULL) bucket; an unknown code returns an empty series.
+  clientId: z.string().trim().min(1).optional()
 }).refine((data) => !data.startDate || data.startDate < data.endDate, {
   message: "startDate must be before endDate"
 });
@@ -14,7 +17,10 @@ const OiStatisticsQueryParams = z.object({
   connector: Connector,
   resolution: z.enum(["1h", "4h", "24h"]),
   startDate: z.coerce.date().optional(),
-  endDate: z.coerce.date().default(() => /* @__PURE__ */ new Date())
+  endDate: z.coerce.date().default(() => /* @__PURE__ */ new Date()),
+  // Per-client scope; absent serves the global series. The literal 'other'
+  // selects the unattributed (NULL) bucket; an unknown code returns an empty series.
+  clientId: z.string().trim().min(1).optional()
 }).refine((data) => !data.startDate || data.startDate < data.endDate, {
   message: "startDate must be before endDate"
 });

package/dist/users/payloads.d.ts

@@ -7,3 +7,11 @@ export declare const UpdateUserDisplayName: z.ZodObject<{
     displayName: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>;
 }, z.core.$strip>;
 export type UpdateUserDisplayName = z.infer<typeof UpdateUserDisplayName>;
+export declare const CreateReferralCode: z.ZodObject<{
+    referralCode: z.ZodString;
+}, z.core.$strip>;
+export type CreateReferralCode = z.infer<typeof CreateReferralCode>;
+export declare const BindReferralCode: z.ZodObject<{
+    referralCode: z.ZodString;
+}, z.core.$strip>;
+export type BindReferralCode = z.infer<typeof BindReferralCode>;

package/dist/users/payloads.js

@@ -22,5 +22,13 @@ const DisplayNameSchema = z.preprocess(
   })
 );
 const UpdateUserDisplayName = z.object({ displayName: DisplayNameSchema }).describe("Payload to update user display name");
+const ReferralCodeSpelling = z.string().min(1).max(32).regex(/^[\x20-\x7E]+$/, "Referral code must contain printable ASCII characters only");
+const IssuedReferralCodeSpelling = z.string().trim().min(1).max(32).regex(/^[A-Za-z0-9_-]+$/, "Referral code must contain only letters, digits, hyphens, or underscores");
+const CreateReferralCode = z.object({
+  referralCode: IssuedReferralCodeSpelling
+}).describe("Payload to issue a referral code to the authenticated user");
+const BindReferralCode = z.object({
+  referralCode: ReferralCodeSpelling
+}).describe("Payload to bind a referral code permanently to the authenticated user");
 
-export { UpdateUserDisplayName, UpdateUserPreferences };
+export { BindReferralCode, CreateReferralCode, UpdateUserDisplayName, UpdateUserPreferences };

package/dist/users/response.d.ts

@@ -26,3 +26,8 @@ export declare const UpdateUserDisplayNameResponse: z.ZodObject<{
     displayName: z.ZodString;
 }, z.core.$strip>;
 export type UpdateUserDisplayNameResponse = z.infer<typeof UpdateUserDisplayNameResponse>;
+export declare const ReferralStatusResponse: z.ZodObject<{
+    ownedCodes: z.ZodArray<z.ZodString>;
+    referrerUserId: z.ZodOptional<z.ZodUUID>;
+}, z.core.$strip>;
+export type ReferralStatusResponse = z.infer<typeof ReferralStatusResponse>;

package/dist/users/response.js

@@ -11,5 +11,9 @@ const UpdateUserPreferencesResponse = z.object({
 const UpdateUserDisplayNameResponse = z.object({
   displayName: z.string().describe("Updated user display name")
 });
+const ReferralStatusResponse = z.object({
+  ownedCodes: z.array(z.string()).describe("Exact case-sensitive referral codes owned by the authenticated user"),
+  referrerUserId: z.uuid().optional().describe("User that permanently referred the authenticated user")
+});
 
-export { ProfileResponse, UpdateUserDisplayNameResponse, UpdateUserPreferencesResponse };
+export { ProfileResponse, ReferralStatusResponse, UpdateUserDisplayNameResponse, UpdateUserPreferencesResponse };

package/package.json

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