@pear-protocol/types 0.0.21 → 1.0.0

package/dist/admin/client-ids/entities.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const ClientIdEntity: z.ZodObject<{
+    id: z.ZodUUID;
+    code: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    isActive: z.ZodBoolean;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type ClientIdEntity = z.output<typeof ClientIdEntity>;

package/dist/admin/client-ids/entities.js

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+
+const ClientIdEntity = z.object({
+  id: z.uuid(),
+  code: z.string(),
+  label: z.string(),
+  description: z.string().optional(),
+  isActive: z.boolean(),
+  createdAt: z.string(),
+  updatedAt: z.string()
+}).describe("Client ID registry entry");
+
+export { ClientIdEntity };

package/dist/admin/client-ids/index.d.ts

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

package/dist/admin/client-ids/index.js

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

package/dist/admin/client-ids/payloads.d.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const CreateClientIdPayload: z.ZodObject<{
+    code: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type CreateClientIdPayloadInput = z.input<typeof CreateClientIdPayload>;
+export type CreateClientIdPayload = z.output<typeof CreateClientIdPayload>;
+export declare const UpdateClientIdPayload: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type UpdateClientIdPayloadInput = z.input<typeof UpdateClientIdPayload>;
+export type UpdateClientIdPayload = z.output<typeof UpdateClientIdPayload>;

package/dist/admin/client-ids/payloads.js

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+
+const CreateClientIdPayload = z.object({
+  code: z.string().min(1).max(64).describe("Stable, immutable attribution key"),
+  label: z.string().min(1).max(128),
+  description: z.string().max(256).optional()
+}).describe("Payload to create a client ID");
+const UpdateClientIdPayload = z.object({
+  label: z.string().min(1).max(128).optional(),
+  description: z.string().max(256).optional()
+}).describe("Payload to update a client ID label/description");
+
+export { CreateClientIdPayload, UpdateClientIdPayload };

package/dist/admin/client-ids/queries.d.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+export declare const ListClientIdsParams: z.ZodObject<{
+    scope: z.ZodDefault<z.ZodEnum<{
+        active: "active";
+        inactive: "inactive";
+        all: "all";
+    }>>;
+}, z.core.$strip>;
+export type ListClientIdsParamsInput = z.input<typeof ListClientIdsParams>;
+export type ListClientIdsParams = z.output<typeof ListClientIdsParams>;

package/dist/admin/client-ids/queries.js

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+const ListClientIdsParams = z.object({
+  scope: z.enum(["active", "inactive", "all"]).default("all")
+});
+
+export { ListClientIdsParams };

package/dist/admin/client-ids/responses.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const ListClientIdsResponse: z.ZodArray<z.ZodObject<{
+    id: z.ZodUUID;
+    code: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    isActive: z.ZodBoolean;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>>;
+export type ListClientIdsResponse = z.output<typeof ListClientIdsResponse>;

package/dist/admin/client-ids/responses.js

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+import { ClientIdEntity } from './entities';
+
+const ListClientIdsResponse = z.array(ClientIdEntity);
+
+export { ListClientIdsResponse };

package/dist/auth/api-keys.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+export declare const ApiKeyScope: z.ZodEnum<{
+    read: "read";
+    read_write: "read_write";
+}>;
+export declare const CreateApiKeyInput: z.ZodObject<{
+    label: z.ZodString;
+    scope: z.ZodDefault<z.ZodEnum<{
+        read: "read";
+        read_write: "read_write";
+    }>>;
+    expiresAt: z.ZodOptional<z.ZodISODateTime>;
+}, z.core.$strip>;
+export declare const CreateApiKeyOutput: z.ZodObject<{
+    id: z.ZodUUID;
+    label: z.ZodString;
+    scope: z.ZodEnum<{
+        read: "read";
+        read_write: "read_write";
+    }>;
+    key: z.ZodString;
+}, z.core.$strip>;
+export declare const ApiKeySummary: z.ZodObject<{
+    id: z.ZodUUID;
+    label: z.ZodString;
+    scope: z.ZodEnum<{
+        read: "read";
+        read_write: "read_write";
+    }>;
+    keyPrefix: z.ZodString;
+    lastUsedAt: z.ZodNullable<z.ZodString>;
+    expiresAt: z.ZodNullable<z.ZodString>;
+    revokedAt: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export declare const ListApiKeysOutput: z.ZodArray<z.ZodObject<{
+    id: z.ZodUUID;
+    label: z.ZodString;
+    scope: z.ZodEnum<{
+        read: "read";
+        read_write: "read_write";
+    }>;
+    keyPrefix: z.ZodString;
+    lastUsedAt: z.ZodNullable<z.ZodString>;
+    expiresAt: z.ZodNullable<z.ZodString>;
+    revokedAt: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+}, z.core.$strip>>;
+export declare const ApiKeyMeResponse: z.ZodObject<{
+    id: z.ZodUUID;
+    role: z.ZodEnum<{
+        basic: "basic";
+        pro: "pro";
+        admin: "admin";
+    }>;
+    scope: z.ZodEnum<{
+        read: "read";
+        read_write: "read_write";
+    }>;
+    authMethod: z.ZodLiteral<"api_key">;
+}, z.core.$strip>;
+export type ApiKeyScope = z.infer<typeof ApiKeyScope>;
+export type CreateApiKeyInput = z.infer<typeof CreateApiKeyInput>;
+export type CreateApiKeyOutput = z.infer<typeof CreateApiKeyOutput>;
+export type ApiKeySummary = z.infer<typeof ApiKeySummary>;
+export type ListApiKeysOutput = z.infer<typeof ListApiKeysOutput>;
+export type ApiKeyMeResponse = z.infer<typeof ApiKeyMeResponse>;

package/dist/auth/api-keys.js

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+
+const ApiKeyScope = z.enum(["read", "read_write"]).describe("API key access scope");
+const CreateApiKeyInput = z.object({
+  label: z.string().trim().min(1, "Label is required").max(100).describe("Human label for the key"),
+  scope: ApiKeyScope.default("read"),
+  /** ISO-8601 datetime; omit for a key that never expires. */
+  expiresAt: z.iso.datetime({ offset: true }).optional().describe("Optional expiry (ISO-8601)")
+}).describe("Create a new API key");
+const CreateApiKeyOutput = z.object({
+  id: z.uuid(),
+  label: z.string(),
+  scope: ApiKeyScope,
+  /** Raw secret — returned only once, at creation. */
+  key: z.string()
+}).describe("Newly created API key (raw secret shown once)");
+const ApiKeySummary = z.object({
+  id: z.uuid(),
+  label: z.string(),
+  scope: ApiKeyScope,
+  keyPrefix: z.string(),
+  lastUsedAt: z.string().nullable(),
+  expiresAt: z.string().nullable(),
+  revokedAt: z.string().nullable(),
+  createdAt: z.string()
+});
+const ListApiKeysOutput = z.array(ApiKeySummary).describe("All API keys for the user");
+const ApiKeyMeResponse = z.object({
+  id: z.uuid().describe("User UUID that owns the API key"),
+  role: z.enum(["basic", "pro", "admin"]).describe("User role"),
+  scope: ApiKeyScope,
+  authMethod: z.literal("api_key")
+}).describe("Identity of the caller authenticated via an API key");
+
+export { ApiKeyMeResponse, ApiKeyScope, ApiKeySummary, CreateApiKeyInput, CreateApiKeyOutput, ListApiKeysOutput };

package/dist/auth/entities.d.ts

@@ -8,6 +8,7 @@ export declare const AuthenticatedUser: z.ZodObject<{
     role: z.ZodEnum<{
         basic: "basic";
         pro: "pro";
+        admin: "admin";
     }>;
     providerId: z.ZodNullable<z.ZodString>;
     loginMethod: z.ZodEnum<{

package/dist/auth/entities.js

@@ -3,7 +3,7 @@ import { z } from 'zod';
 const LoginMethod = z.enum(["email", "evm_wallet"]).describe("Authentication provider used for the current session");
 const AuthenticatedUser = z.object({
   id: z.uuid().describe("User UUID"),
-  role: z.enum(["basic", "pro"]).describe("User role"),
+  role: z.enum(["basic", "pro", "admin"]).describe("User role"),
   providerId: z.string().nullable().describe("Provider identifier (wallet address or email)"),
   loginMethod: LoginMethod.describe("Authentication provider used for the current session")
 }).describe("Current authenticated user info");

package/dist/auth/index.d.ts

@@ -1,3 +1,4 @@
+export * from './api-keys';
 export * from './entities';
 export * from './payloads';
 export * from './response';

package/dist/auth/index.js

@@ -1,3 +1,4 @@
+export * from './api-keys';
 export * from './entities';
 export * from './payloads';
 export * from './response';

package/dist/auth/response.d.ts

@@ -7,6 +7,7 @@ export declare const LoginResponse: z.ZodObject<{
         role: z.ZodEnum<{
             basic: "basic";
             pro: "pro";
+            admin: "admin";
         }>;
         providerId: z.ZodNullable<z.ZodString>;
         loginMethod: z.ZodEnum<{
@@ -41,6 +42,7 @@ export declare const MeResponse: z.ZodObject<{
     role: z.ZodEnum<{
         basic: "basic";
         pro: "pro";
+        admin: "admin";
     }>;
     providerId: z.ZodNullable<z.ZodString>;
     loginMethod: z.ZodEnum<{

package/dist/bundle.d.ts

@@ -1,3 +1,4 @@
+export * from './admin/client-ids';
 export * from './auth';
 export * from './common/trade-legs';
 export * from './connector';
@@ -7,15 +8,19 @@ export * from './funding';
 export * from './instrument';
 export * from './instrument-precision';
 export * from './leverage';
+export * from './market';
 export * from './misc';
 export * from './order';
+export * from './portfolio';
 export * from './position';
 export * from './price';
 export * from './rebalance';
 export * from './schedule';
 export * from './statistics';
 export * from './sync';
+export * from './tca';
 export * from './trade';
 export * from './trade-accounts';
 export * from './trigger';
+export * from './triggers';
 export * from './users';

package/dist/bundle.js

@@ -1,3 +1,4 @@
+export * from './admin/client-ids';
 export * from './auth';
 export * from './common/trade-legs';
 export * from './connector';
@@ -7,15 +8,19 @@ export * from './funding';
 export * from './instrument';
 export * from './instrument-precision';
 export * from './leverage';
+export * from './market';
 export * from './misc';
 export * from './order';
+export * from './portfolio';
 export * from './position';
 export * from './price';
 export * from './rebalance';
 export * from './schedule';
 export * from './statistics';
 export * from './sync';
+export * from './tca';
 export * from './trade';
 export * from './trade-accounts';
 export * from './trigger';
+export * from './triggers';
 export * from './users';

package/dist/common/client-id.d.ts

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const ClientIdCode: z.ZodOptional<z.ZodString>;

package/dist/common/client-id.js

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+
+const ClientIdCode = z.string().min(1).max(64).optional().describe("Attribution route code (client_ids.code)");
+
+export { ClientIdCode };

package/dist/common/index.d.ts

@@ -1,3 +1,4 @@
 export * from './array';
+export * from './client-id';
 export * from './request';
 export * from './response';

package/dist/common/index.js

@@ -1,3 +1,4 @@
 export * from './array';
+export * from './client-id';
 export * from './request';
 export * from './response';

package/dist/instrument/queries.d.ts

@@ -1,9 +1,9 @@
 import { z } from 'zod';
 export declare const InstrumentScope: z.ZodEnum<{
+    all: "all";
     tradable: "tradable";
     reduce_only: "reduce_only";
     not_tradable: "not_tradable";
-    all: "all";
 }>;
 export type InstrumentScope = z.infer<typeof InstrumentScope>;
 export declare const InstrumentListParams: z.ZodObject<{
@@ -15,10 +15,10 @@ export declare const InstrumentListParams: z.ZodObject<{
         lighter: "lighter";
     }>;
     scope: z.ZodDefault<z.ZodEnum<{
+        all: "all";
         tradable: "tradable";
         reduce_only: "reduce_only";
         not_tradable: "not_tradable";
-        all: "all";
     }>>;
 }, z.core.$strip>;
 export type InstrumentListParamsInput = z.input<typeof InstrumentListParams>;

package/dist/market/entities.d.ts

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+export declare const Market: z.ZodObject<{
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+    instrumentId: z.ZodString;
+    displaySymbol: z.ZodString;
+    base: z.ZodString;
+    quote: z.ZodString;
+    price: z.ZodString;
+    volume24h: z.ZodString;
+    change24h: z.ZodString;
+    openInterest: z.ZodString;
+    fundingRate: z.ZodString;
+    tradeability: z.ZodObject<{
+        status: z.ZodEnum<{
+            tradable: "tradable";
+            reduce_only: "reduce_only";
+            not_tradable: "not_tradable";
+        }>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    updatedAt: z.ZodNumber;
+}, z.core.$strip>;
+export type Market = z.output<typeof Market>;
+export declare const BasketMarket: z.ZodObject<{
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+    basketKey: z.ZodString;
+    displaySymbol: z.ZodString;
+    longInstrumentIds: z.ZodArray<z.ZodString>;
+    shortInstrumentIds: z.ZodArray<z.ZodString>;
+    price: z.ZodString;
+    priceChange24h: z.ZodString;
+    weightRatio: z.ZodString;
+    weightRatioChange24h: z.ZodString;
+    netFunding: z.ZodString;
+    volume24h: z.ZodString;
+    openInterest: z.ZodString;
+    tradeability: z.ZodObject<{
+        status: z.ZodEnum<{
+            tradable: "tradable";
+            reduce_only: "reduce_only";
+            not_tradable: "not_tradable";
+        }>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    updatedAt: z.ZodNumber;
+    hasMaterializedStats: z.ZodBoolean;
+}, z.core.$strip>;
+export type BasketMarket = z.output<typeof BasketMarket>;
+export declare const MarketTotals: z.ZodObject<{
+    markets: z.ZodNumber;
+    volume24h: z.ZodString;
+    openInterest: z.ZodString;
+}, z.core.$strip>;
+export type MarketTotals = z.output<typeof MarketTotals>;

package/dist/market/entities.js

@@ -0,0 +1,42 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+import { InstrumentTradeability, InstrumentId } from '../instrument';
+
+const Market = z.object({
+  connector: Connector,
+  instrumentId: InstrumentId,
+  displaySymbol: z.string(),
+  base: z.string(),
+  quote: z.string(),
+  price: z.string(),
+  volume24h: z.string(),
+  change24h: z.string(),
+  openInterest: z.string(),
+  fundingRate: z.string(),
+  tradeability: InstrumentTradeability,
+  updatedAt: z.number()
+});
+const BasketMarket = z.object({
+  connector: Connector,
+  basketKey: z.string(),
+  displaySymbol: z.string(),
+  longInstrumentIds: z.array(InstrumentId),
+  shortInstrumentIds: z.array(InstrumentId),
+  price: z.string(),
+  priceChange24h: z.string(),
+  weightRatio: z.string(),
+  weightRatioChange24h: z.string(),
+  netFunding: z.string(),
+  volume24h: z.string(),
+  openInterest: z.string(),
+  tradeability: InstrumentTradeability,
+  updatedAt: z.number(),
+  hasMaterializedStats: z.boolean()
+});
+const MarketTotals = z.object({
+  markets: z.number(),
+  volume24h: z.string(),
+  openInterest: z.string()
+});
+
+export { BasketMarket, Market, MarketTotals };

package/dist/market/index.d.ts

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

package/dist/market/index.js

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

package/dist/market/queries.d.ts

@@ -0,0 +1,38 @@
+import { z } from 'zod';
+export declare const MarketsQueryParams: z.ZodObject<{
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+    scope: z.ZodDefault<z.ZodEnum<{
+        all: "all";
+        tradable: "tradable";
+        reduce_only: "reduce_only";
+        not_tradable: "not_tradable";
+    }>>;
+}, z.core.$strip>;
+export type MarketsQueryParamsInput = z.input<typeof MarketsQueryParams>;
+export type MarketsQueryParams = z.output<typeof MarketsQueryParams>;
+export declare const MarketBasketsQueryParams: z.ZodObject<{
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+    }>;
+    scope: z.ZodDefault<z.ZodEnum<{
+        all: "all";
+        tradable: "tradable";
+        reduce_only: "reduce_only";
+        not_tradable: "not_tradable";
+    }>>;
+    search: z.ZodOptional<z.ZodString>;
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+export type MarketBasketsQueryParamsInput = z.input<typeof MarketBasketsQueryParams>;
+export type MarketBasketsQueryParams = z.output<typeof MarketBasketsQueryParams>;

package/dist/market/queries.js

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { Connector } from '../connector';
+import { InstrumentScope } from '../instrument';
+
+const MarketsQueryParams = z.object({
+  connector: Connector,
+  // Markets are connector-scoped so the API can return one exchange's live view
+  // without mixing instruments that have different ids, liquidity, or stats feeds.
+  scope: InstrumentScope.default("tradable")
+});
+const MarketBasketsQueryParams = z.object({
+  connector: Connector,
+  scope: InstrumentScope.default("tradable"),
+  search: z.string().trim().max(128).optional(),
+  limit: z.coerce.number().int().min(1).max(1e3).default(500),
+  offset: z.coerce.number().int().min(0).default(0)
+});
+
+export { MarketBasketsQueryParams, MarketsQueryParams };

package/dist/market/responses.d.ts

@@ -0,0 +1,72 @@
+import { z } from 'zod';
+export declare const MarketsResponse: z.ZodObject<{
+    markets: z.ZodArray<z.ZodObject<{
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        instrumentId: z.ZodString;
+        displaySymbol: z.ZodString;
+        base: z.ZodString;
+        quote: z.ZodString;
+        price: z.ZodString;
+        volume24h: z.ZodString;
+        change24h: z.ZodString;
+        openInterest: z.ZodString;
+        fundingRate: z.ZodString;
+        tradeability: z.ZodObject<{
+            status: z.ZodEnum<{
+                tradable: "tradable";
+                reduce_only: "reduce_only";
+                not_tradable: "not_tradable";
+            }>;
+            reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+        updatedAt: z.ZodNumber;
+    }, z.core.$strip>>;
+    totals: z.ZodObject<{
+        markets: z.ZodNumber;
+        volume24h: z.ZodString;
+        openInterest: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type MarketsResponse = z.output<typeof MarketsResponse>;
+export declare const MarketBasketsResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    offset: z.ZodNumber;
+    count: z.ZodNumber;
+    markets: z.ZodArray<z.ZodObject<{
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+        }>;
+        basketKey: z.ZodString;
+        displaySymbol: z.ZodString;
+        longInstrumentIds: z.ZodArray<z.ZodString>;
+        shortInstrumentIds: z.ZodArray<z.ZodString>;
+        price: z.ZodString;
+        priceChange24h: z.ZodString;
+        weightRatio: z.ZodString;
+        weightRatioChange24h: z.ZodString;
+        netFunding: z.ZodString;
+        volume24h: z.ZodString;
+        openInterest: z.ZodString;
+        tradeability: z.ZodObject<{
+            status: z.ZodEnum<{
+                tradable: "tradable";
+                reduce_only: "reduce_only";
+                not_tradable: "not_tradable";
+            }>;
+            reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+        updatedAt: z.ZodNumber;
+        hasMaterializedStats: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type MarketBasketsResponse = z.output<typeof MarketBasketsResponse>;

package/dist/market/responses.js

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+import { MarketTotals, Market, BasketMarket } from './entities';
+
+const MarketsResponse = z.object({
+  markets: z.array(Market),
+  totals: MarketTotals
+});
+const MarketBasketsResponse = z.object({
+  limit: z.number(),
+  offset: z.number(),
+  count: z.number(),
+  markets: z.array(BasketMarket)
+});
+
+export { MarketBasketsResponse, MarketsResponse };