@limitless-exchange/sdk 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosRequestConfig, RawAxiosResponseHeaders, AxiosResponseHeaders } from 'axios';
 import { ethers } from 'ethers';
 
 /**
@@ -1096,11 +1096,15 @@ interface MarketSettings {
     /**
      * Rewards epoch duration
      */
-    rewardsEpoch: string;
+    rewardsEpoch: string | number;
     /**
      * Constant parameter
      */
-    c: string;
+    c: string | number;
+    /**
+     * Market maker rebate rate.
+     */
+    rebateRate?: number;
 }
 /**
  * Trade prices for different order types.
@@ -1257,7 +1261,7 @@ interface Venue {
      * Required for NegRisk/Grouped markets only.
      * SELL orders on NegRisk markets require CT approval to both exchange AND adapter.
      */
-    adapter: string;
+    adapter: string | null;
 }
 /**
  * Market token IDs for CLOB markets.
@@ -1358,6 +1362,38 @@ interface Market$1 {
      * Formatted trading volume
      */
     volumeFormatted?: string;
+    /**
+     * Market automation type.
+     */
+    automationType?: 'manual' | 'lumy' | 'sports';
+    /**
+     * Primary market image URL.
+     */
+    imageUrl?: string | null;
+    /**
+     * Price trend data.
+     */
+    trends?: Record<string, unknown>;
+    /**
+     * Open interest (AMM markets).
+     */
+    openInterest?: string;
+    /**
+     * Formatted open interest (AMM markets).
+     */
+    openInterestFormatted?: string;
+    /**
+     * Liquidity (AMM markets).
+     */
+    liquidity?: string;
+    /**
+     * Formatted liquidity (AMM markets).
+     */
+    liquidityFormatted?: string;
+    /**
+     * Position IDs (AMM markets).
+     */
+    positionIds?: string[];
     /**
      * Condition ID (CLOB only)
      */
@@ -1897,6 +1933,28 @@ interface HttpClientConfig {
      */
     additionalHeaders?: Record<string, string>;
 }
+/**
+ * Raw HTTP response with status and headers.
+ *
+ * @remarks
+ * Useful for endpoints where response metadata matters (for example redirect handling).
+ *
+ * @public
+ */
+interface HttpRawResponse<T = any> {
+    /**
+     * HTTP status code.
+     */
+    status: number;
+    /**
+     * Response headers.
+     */
+    headers: RawAxiosResponseHeaders | AxiosResponseHeaders;
+    /**
+     * Response body.
+     */
+    data: T;
+}
 /**
  * HTTP client wrapper for Limitless Exchange API.
  *
@@ -1921,6 +1979,16 @@ declare class HttpClient {
      * @internal
      */
     private setupInterceptors;
+    /**
+     * Extracts a human-readable error message from API response payload.
+     * @internal
+     */
+    private extractErrorMessage;
+    /**
+     * Creates a typed API error class from status code.
+     * @internal
+     */
+    private createTypedApiError;
     /**
      * Sets the API key for authenticated requests.
      *
@@ -1939,6 +2007,17 @@ declare class HttpClient {
      * @returns Promise resolving to the response data
      */
     get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    /**
+     * Performs a GET request and returns raw response metadata.
+     *
+     * @remarks
+     * Use this when callers need access to status code or headers (e.g. redirect `Location`).
+     *
+     * @param url - Request URL
+     * @param config - Additional request configuration
+     * @returns Promise resolving to status, headers, and response data
+     */
+    getRaw<T = any>(url: string, config?: AxiosRequestConfig): Promise<HttpRawResponse<T>>;
     /**
      * Performs a POST request.
      *
@@ -1998,6 +2077,14 @@ declare class Market {
     metadata: MarketMetadata;
     volume?: string;
     volumeFormatted?: string;
+    automationType?: 'manual' | 'lumy' | 'sports';
+    imageUrl?: string | null;
+    trends?: Record<string, unknown>;
+    openInterest?: string;
+    openInterestFormatted?: string;
+    liquidity?: string;
+    liquidityFormatted?: string;
+    positionIds?: string[];
     conditionId?: string;
     negRiskRequestId?: string | null;
     tokens?: MarketTokens;
@@ -2048,6 +2135,159 @@ declare class Market {
     getUserOrders(): Promise<any[]>;
 }
 
+/**
+ * Navigation node returned by /navigation endpoint.
+ * @public
+ */
+interface NavigationNode {
+    id: string;
+    name: string;
+    slug: string;
+    path: string;
+    icon?: string;
+    children: NavigationNode[];
+}
+/**
+ * Filter group option for market pages.
+ * @public
+ */
+interface FilterGroupOption {
+    label: string;
+    value: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Filter group for market pages.
+ * @public
+ */
+interface FilterGroup {
+    name?: string;
+    slug?: string;
+    allowMultiple?: boolean;
+    presentation?: string;
+    options?: FilterGroupOption[];
+    source?: Record<string, unknown>;
+}
+/**
+ * Breadcrumb item returned by /market-pages/by-path endpoint.
+ * @public
+ */
+interface BreadcrumbItem {
+    name: string;
+    slug: string;
+    path: string;
+}
+/**
+ * Market page data resolved by path.
+ * @public
+ */
+interface MarketPage {
+    id: string;
+    name: string;
+    slug: string;
+    fullPath: string;
+    description: string | null;
+    baseFilter: Record<string, unknown>;
+    filterGroups: FilterGroup[];
+    metadata: Record<string, unknown>;
+    breadcrumb: BreadcrumbItem[];
+}
+/**
+ * Property option returned by property-keys endpoints.
+ * @public
+ */
+interface PropertyOption {
+    id: string;
+    propertyKeyId: string;
+    value: string;
+    label: string;
+    sortOrder: number;
+    parentOptionId: string | null;
+    metadata: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Property key returned by property-keys endpoints.
+ * @public
+ */
+interface PropertyKey {
+    id: string;
+    name: string;
+    slug: string;
+    type: 'select' | 'multi-select';
+    metadata: Record<string, unknown>;
+    isSystem: boolean;
+    options?: PropertyOption[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Offset pagination metadata.
+ * @public
+ */
+interface OffsetPagination {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+}
+/**
+ * Cursor pagination metadata.
+ * @public
+ */
+interface CursorPagination {
+    nextCursor: string | null;
+}
+/**
+ * Sort field for market-pages market listing.
+ * @public
+ */
+type MarketPageSortField = 'createdAt' | 'updatedAt' | 'deadline' | 'id';
+/**
+ * Sort value for market-pages market listing.
+ * @public
+ */
+type MarketPageSort = MarketPageSortField | `-${MarketPageSortField}`;
+/**
+ * Query params for /market-pages/:id/markets endpoint.
+ * @public
+ */
+type MarketPageFilterPrimitive = string | number | boolean;
+type MarketPageFilterValue = MarketPageFilterPrimitive | MarketPageFilterPrimitive[];
+/**
+ * Query params for /market-pages/:id/markets endpoint.
+ * @public
+ */
+interface MarketPageMarketsParams {
+    page?: number;
+    limit?: number;
+    sort?: MarketPageSort;
+    cursor?: string;
+    filters?: Record<string, MarketPageFilterValue>;
+}
+/**
+ * Offset response for /market-pages/:id/markets endpoint.
+ * @public
+ */
+interface MarketPageMarketsOffsetResponse {
+    data: Market[];
+    pagination: OffsetPagination;
+}
+/**
+ * Cursor response for /market-pages/:id/markets endpoint.
+ * @public
+ */
+interface MarketPageMarketsCursorResponse {
+    data: Market[];
+    cursor: CursorPagination;
+}
+/**
+ * Union response for /market-pages/:id/markets endpoint.
+ * @public
+ */
+type MarketPageMarketsResponse = MarketPageMarketsOffsetResponse | MarketPageMarketsCursorResponse;
+
 /**
  * API error types for Limitless Exchange SDK.
  * @module api/errors
@@ -3187,6 +3427,57 @@ declare class OrderClient {
     get ownerId(): number | undefined;
 }
 
+/**
+ * Fetcher for market-pages and property-keys APIs.
+ *
+ * @remarks
+ * This class provides access to the new navigation-driven market discovery API.
+ *
+ * @public
+ */
+declare class MarketPageFetcher {
+    private httpClient;
+    private logger;
+    /**
+     * Creates a new market-pages fetcher.
+     *
+     * @param httpClient - HTTP client for API calls
+     * @param logger - Optional logger
+     */
+    constructor(httpClient: HttpClient, logger?: ILogger);
+    /**
+     * Gets the navigation tree.
+     */
+    getNavigation(): Promise<NavigationNode[]>;
+    /**
+     * Resolves a market page by path.
+     *
+     * @remarks
+     * Handles 301 redirects manually by re-requesting `/market-pages/by-path` with the
+     * redirected path value from `Location` header.
+     */
+    getMarketPageByPath(path: string): Promise<MarketPage>;
+    private getMarketPageByPathInternal;
+    private extractRedirectPath;
+    /**
+     * Gets markets for a market page with optional filtering and pagination.
+     */
+    getMarkets(pageId: string, params?: MarketPageMarketsParams): Promise<MarketPageMarketsResponse>;
+    /**
+     * Lists all property keys with options.
+     */
+    getPropertyKeys(): Promise<PropertyKey[]>;
+    /**
+     * Gets a single property key by ID.
+     */
+    getPropertyKey(id: string): Promise<PropertyKey>;
+    /**
+     * Lists options for a property key, optionally filtered by parent option ID.
+     */
+    getPropertyOptions(keyId: string, parentId?: string): Promise<PropertyOption[]>;
+    private stringifyFilterValue;
+}
+
 /**
  * Portfolio data fetcher for Limitless Exchange.
  * @module portfolio/fetcher
@@ -3530,4 +3821,4 @@ declare class WebSocketClient {
     private getChannelFromKey;
 }
 
-export { type AMMPosition, APIError, type ActiveMarketsParams, type ActiveMarketsResponse, type ActiveMarketsSortBy, type AmmPriceEntry, AuthenticationError, BASE_SEPOLIA_CHAIN_ID, type BaseOrderArgs, type CLOBPosition, CONTRACT_ADDRESSES, type CollateralToken, ConsoleLogger, type CreatedOrder, DEFAULT_API_URL, DEFAULT_CHAIN_ID, DEFAULT_WS_URL, type FOKOrderArgs, type FillEvent, type GTCOrderArgs, type HistoryEntry, type HistoryResponse, HttpClient, type HttpClientConfig, type ILogger, type LatestTrade, Market, type MarketCreator, MarketFetcher, type Market$1 as MarketInterface, type MarketMetadata, type MarketOutcome, type MarketSettings, type MarketTokens, type MarketUpdate, type MarketsResponse, type ModeInfo, type NewOrderPayload, type NewPriceData, NoOpLogger, type OrderArgs, type OrderBook, OrderBuilder, OrderClient, type OrderClientConfig, type OrderMatch, type OrderResponse, OrderSigner, type OrderSigningConfig, OrderType, type OrderUpdate, OrderValidationError, type OrderbookData, type OrderbookEntry, type OrderbookUpdate, PortfolioFetcher, type PortfolioPositionsResponse, type PortfolioSummary, type Position, type PositionMarket, type PositionSide, type PriceOracleMetadata, type PriceUpdate, RateLimitError, type ReferralData, RetryConfig, type RetryConfigOptions, RetryableClient, SIGNING_MESSAGE_TEMPLATE, Side, SignatureType, type SignedOrder, type SubscriptionChannel, type SubscriptionOptions, type TokenBalance, type TradeEvent, type TradePrices, type TradingMode, type TransactionEvent, type UnsignedOrder, type UserData, type UserProfile, type UserRank, ValidationError, type Venue, WebSocketClient, type WebSocketConfig, type WebSocketEvents, WebSocketState, ZERO_ADDRESS, getContractAddress, retryOnErrors, validateOrderArgs, validateSignedOrder, validateUnsignedOrder, withRetry };
+export { type AMMPosition, APIError, type ActiveMarketsParams, type ActiveMarketsResponse, type ActiveMarketsSortBy, type AmmPriceEntry, AuthenticationError, BASE_SEPOLIA_CHAIN_ID, type BaseOrderArgs, type BreadcrumbItem, type CLOBPosition, CONTRACT_ADDRESSES, type CollateralToken, ConsoleLogger, type CreatedOrder, type CursorPagination, DEFAULT_API_URL, DEFAULT_CHAIN_ID, DEFAULT_WS_URL, type FOKOrderArgs, type FillEvent, type FilterGroup, type FilterGroupOption, type GTCOrderArgs, type HistoryEntry, type HistoryResponse, HttpClient, type HttpClientConfig, type HttpRawResponse, type ILogger, type LatestTrade, Market, type MarketCreator, MarketFetcher, type Market$1 as MarketInterface, type MarketMetadata, type MarketOutcome, type MarketPage, MarketPageFetcher, type MarketPageFilterPrimitive, type MarketPageFilterValue, type MarketPageMarketsCursorResponse, type MarketPageMarketsOffsetResponse, type MarketPageMarketsParams, type MarketPageMarketsResponse, type MarketPageSort, type MarketPageSortField, type MarketSettings, type MarketTokens, type MarketUpdate, type MarketsResponse, type ModeInfo, type NavigationNode, type NewOrderPayload, type NewPriceData, NoOpLogger, type OffsetPagination, type OrderArgs, type OrderBook, OrderBuilder, OrderClient, type OrderClientConfig, type OrderMatch, type OrderResponse, OrderSigner, type OrderSigningConfig, OrderType, type OrderUpdate, OrderValidationError, type OrderbookData, type OrderbookEntry, type OrderbookUpdate, PortfolioFetcher, type PortfolioPositionsResponse, type PortfolioSummary, type Position, type PositionMarket, type PositionSide, type PriceOracleMetadata, type PriceUpdate, type PropertyKey, type PropertyOption, RateLimitError, type ReferralData, RetryConfig, type RetryConfigOptions, RetryableClient, SIGNING_MESSAGE_TEMPLATE, Side, SignatureType, type SignedOrder, type SubscriptionChannel, type SubscriptionOptions, type TokenBalance, type TradeEvent, type TradePrices, type TradingMode, type TransactionEvent, type UnsignedOrder, type UserData, type UserProfile, type UserRank, ValidationError, type Venue, WebSocketClient, type WebSocketConfig, type WebSocketEvents, WebSocketState, ZERO_ADDRESS, getContractAddress, retryOnErrors, validateOrderArgs, validateSignedOrder, validateUnsignedOrder, withRetry };

package/dist/index.js

@@ -41,6 +41,7 @@ __export(index_exports, {
   HttpClient: () => HttpClient,
   Market: () => Market,
   MarketFetcher: () => MarketFetcher,
+  MarketPageFetcher: () => MarketPageFetcher,
   NoOpLogger: () => NoOpLogger,
   OrderBuilder: () => OrderBuilder,
   OrderClient: () => OrderClient,
@@ -421,6 +422,42 @@ var HttpClient = class {
       }
     );
   }
+  /**
+   * Extracts a human-readable error message from API response payload.
+   * @internal
+   */
+  extractErrorMessage(data, fallback) {
+    if (!data) {
+      return fallback;
+    }
+    if (typeof data === "object") {
+      if (Array.isArray(data.message)) {
+        const messages = data.message.map((err) => {
+          const details = Object.entries(err || {}).filter(([_key, val]) => val !== "" && val !== null && val !== void 0).map(([key, val]) => `${key}: ${val}`).join(", ");
+          return details || JSON.stringify(err);
+        }).filter((msg) => msg.trim() !== "").join(" | ");
+        return messages || data.error || JSON.stringify(data);
+      }
+      return data.message || data.error || data.msg || data.errors && JSON.stringify(data.errors) || JSON.stringify(data);
+    }
+    return String(data);
+  }
+  /**
+   * Creates a typed API error class from status code.
+   * @internal
+   */
+  createTypedApiError(status, message, data, url, method) {
+    if (status === 429) {
+      return new RateLimitError(message, status, data, url, method);
+    }
+    if (status === 401 || status === 403) {
+      return new AuthenticationError(message, status, data, url, method);
+    }
+    if (status === 400) {
+      return new ValidationError(message, status, data, url, method);
+    }
+    return new APIError(message, status, data, url, method);
+  }
   /**
    * Sets the API key for authenticated requests.
    *
@@ -446,6 +483,28 @@ var HttpClient = class {
     const response = await this.client.get(url, config);
     return response.data;
   }
+  /**
+   * Performs a GET request and returns raw response metadata.
+   *
+   * @remarks
+   * Use this when callers need access to status code or headers (e.g. redirect `Location`).
+   *
+   * @param url - Request URL
+   * @param config - Additional request configuration
+   * @returns Promise resolving to status, headers, and response data
+   */
+  async getRaw(url, config) {
+    const response = await this.client.get(url, config);
+    if (response.status >= 400) {
+      const message = this.extractErrorMessage(response.data, `Request failed with status ${response.status}`);
+      throw this.createTypedApiError(response.status, message, response.data, url, "GET");
+    }
+    return {
+      status: response.status,
+      headers: response.headers,
+      data: response.data
+    };
+  }
   /**
    * Performs a POST request.
    *
@@ -1092,7 +1151,7 @@ var OrderValidationError = class extends Error {
   }
 };
 function isFOKOrder(args) {
-  return "amount" in args;
+  return "makerAmount" in args;
 }
 function validateOrderArgs(args) {
   if (!args.tokenId) {
@@ -1880,6 +1939,174 @@ var OrderClient = class {
   }
 };
 
+// src/market-pages/fetcher.ts
+var MAX_REDIRECT_DEPTH = 3;
+var MarketPageFetcher = class {
+  /**
+   * Creates a new market-pages fetcher.
+   *
+   * @param httpClient - HTTP client for API calls
+   * @param logger - Optional logger
+   */
+  constructor(httpClient, logger) {
+    this.httpClient = httpClient;
+    this.logger = logger || new NoOpLogger();
+  }
+  /**
+   * Gets the navigation tree.
+   */
+  async getNavigation() {
+    this.logger.debug("Fetching navigation tree");
+    return this.httpClient.get("/navigation");
+  }
+  /**
+   * Resolves a market page by path.
+   *
+   * @remarks
+   * Handles 301 redirects manually by re-requesting `/market-pages/by-path` with the
+   * redirected path value from `Location` header.
+   */
+  async getMarketPageByPath(path) {
+    return this.getMarketPageByPathInternal(path, 0);
+  }
+  async getMarketPageByPathInternal(path, depth) {
+    const query = new URLSearchParams({ path }).toString();
+    const endpoint = `/market-pages/by-path?${query}`;
+    const requestConfig = {
+      maxRedirects: 0,
+      validateStatus: (status) => status === 200 || status === 301
+    };
+    this.logger.debug("Resolving market page by path", { path, depth });
+    const response = await this.httpClient.getRaw(endpoint, requestConfig);
+    if (response.status === 200) {
+      return response.data;
+    }
+    if (response.status !== 301) {
+      throw new Error(`Unexpected response status: ${response.status}`);
+    }
+    if (depth >= MAX_REDIRECT_DEPTH) {
+      throw new Error(
+        `Too many redirects while resolving market page path '${path}' (max ${MAX_REDIRECT_DEPTH})`
+      );
+    }
+    const locationHeader = response.headers?.location;
+    const location = Array.isArray(locationHeader) ? locationHeader[0] : locationHeader;
+    if (!location || typeof location !== "string") {
+      throw new Error("Redirect response missing valid Location header");
+    }
+    const redirectedPath = this.extractRedirectPath(location);
+    this.logger.info("Following market page redirect", {
+      from: path,
+      to: redirectedPath,
+      depth: depth + 1
+    });
+    return this.getMarketPageByPathInternal(redirectedPath, depth + 1);
+  }
+  extractRedirectPath(location) {
+    const directByPathPrefix = "/market-pages/by-path";
+    if (location.startsWith(directByPathPrefix)) {
+      const url = new URL(location, "https://api.limitless.exchange");
+      const path = url.searchParams.get("path");
+      if (!path) {
+        throw new Error("Redirect location '/market-pages/by-path' is missing required 'path' query parameter");
+      }
+      return path;
+    }
+    if (/^https?:\/\//i.test(location)) {
+      const url = new URL(location);
+      if (url.pathname === directByPathPrefix) {
+        const path = url.searchParams.get("path");
+        if (!path) {
+          throw new Error("Redirect location '/market-pages/by-path' is missing required 'path' query parameter");
+        }
+        return path;
+      }
+      return url.pathname || "/";
+    }
+    return location;
+  }
+  /**
+   * Gets markets for a market page with optional filtering and pagination.
+   */
+  async getMarkets(pageId, params = {}) {
+    if (params.cursor !== void 0 && params.page !== void 0) {
+      throw new Error("Parameters `cursor` and `page` are mutually exclusive");
+    }
+    const query = new URLSearchParams();
+    if (params.page !== void 0) {
+      query.append("page", String(params.page));
+    }
+    if (params.limit !== void 0) {
+      query.append("limit", String(params.limit));
+    }
+    if (params.sort) {
+      query.append("sort", params.sort);
+    }
+    if (params.cursor !== void 0) {
+      query.append("cursor", params.cursor);
+    }
+    if (params.filters) {
+      for (const [key, value] of Object.entries(params.filters)) {
+        if (Array.isArray(value)) {
+          for (const item of value) {
+            query.append(key, this.stringifyFilterValue(item));
+          }
+        } else {
+          query.append(key, this.stringifyFilterValue(value));
+        }
+      }
+    }
+    const queryString = query.toString();
+    const endpoint = `/market-pages/${pageId}/markets${queryString ? `?${queryString}` : ""}`;
+    this.logger.debug("Fetching market-page markets", { pageId, params });
+    const response = await this.httpClient.get(endpoint);
+    const markets = (response.data || []).map((marketData) => new Market(marketData, this.httpClient));
+    if (response.pagination) {
+      return {
+        data: markets,
+        pagination: response.pagination
+      };
+    }
+    if (response.cursor) {
+      return {
+        data: markets,
+        cursor: response.cursor
+      };
+    }
+    throw new Error("Invalid market-page response: expected `pagination` or `cursor` metadata");
+  }
+  /**
+   * Lists all property keys with options.
+   */
+  async getPropertyKeys() {
+    return this.httpClient.get("/property-keys");
+  }
+  /**
+   * Gets a single property key by ID.
+   */
+  async getPropertyKey(id) {
+    return this.httpClient.get(`/property-keys/${id}`);
+  }
+  /**
+   * Lists options for a property key, optionally filtered by parent option ID.
+   */
+  async getPropertyOptions(keyId, parentId) {
+    const query = new URLSearchParams();
+    if (parentId) {
+      query.append("parentId", parentId);
+    }
+    const queryString = query.toString();
+    const endpoint = `/property-keys/${keyId}/options${queryString ? `?${queryString}` : ""}`;
+    return this.httpClient.get(endpoint);
+  }
+  stringifyFilterValue(value) {
+    if (typeof value === "boolean") {
+      return value ? "true" : "false";
+    }
+    return String(value);
+  }
+};
+
 // src/websocket/client.ts
 var import_socket = require("socket.io-client");
 var WebSocketClient = class {
@@ -2263,6 +2490,7 @@ var WebSocketClient = class {
   HttpClient,
   Market,
   MarketFetcher,
+  MarketPageFetcher,
   NoOpLogger,
   OrderBuilder,
   OrderClient,