pmxtjs 0.4.3 → 1.0.0-b2

package/dist/esm/pmxt/models.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Data models for PMXT TypeScript SDK.
+ *
+ * These are clean TypeScript interfaces that provide a user-friendly API.
+ */
+/**
+ * A single tradeable outcome within a market.
+ */
+export interface MarketOutcome {
+    /**
+     * Outcome ID. Use this for fetchOHLCV/fetchOrderBook/fetchTrades.
+     * - Polymarket: CLOB Token ID
+     * - Kalshi: Market Ticker
+     */
+    id: string;
+    /** Human-readable label (e.g., "Trump", "Yes") */
+    label: string;
+    /** Current price (0.0 to 1.0, representing probability) */
+    price: number;
+    /** 24-hour price change */
+    priceChange24h?: number;
+    /** Exchange-specific metadata */
+    metadata?: Record<string, any>;
+}
+/**
+ * A unified market representation across exchanges.
+ */
+export interface UnifiedMarket {
+    /** Market ID */
+    id: string;
+    /** Market title */
+    title: string;
+    /** All tradeable outcomes */
+    outcomes: MarketOutcome[];
+    /** 24-hour trading volume (USD) */
+    volume24h: number;
+    /** Current liquidity (USD) */
+    liquidity: number;
+    /** Direct URL to the market */
+    url: string;
+    /** Market description */
+    description?: string;
+    /** Expected resolution date */
+    resolutionDate?: Date;
+    /** Total volume (USD) */
+    volume?: number;
+    /** Open interest (USD) */
+    openInterest?: number;
+    /** Market image URL */
+    image?: string;
+    /** Market category */
+    category?: string;
+    /** Market tags */
+    tags?: string[];
+}
+/**
+ * OHLCV price candle.
+ */
+export interface PriceCandle {
+    /** Unix timestamp (milliseconds) */
+    timestamp: number;
+    /** Opening price (0.0 to 1.0) */
+    open: number;
+    /** Highest price (0.0 to 1.0) */
+    high: number;
+    /** Lowest price (0.0 to 1.0) */
+    low: number;
+    /** Closing price (0.0 to 1.0) */
+    close: number;
+    /** Trading volume */
+    volume?: number;
+}
+/**
+ * A single price level in the order book.
+ */
+export interface OrderLevel {
+    /** Price (0.0 to 1.0) */
+    price: number;
+    /** Number of contracts */
+    size: number;
+}
+/**
+ * Current order book for an outcome.
+ */
+export interface OrderBook {
+    /** Bid orders (sorted high to low) */
+    bids: OrderLevel[];
+    /** Ask orders (sorted low to high) */
+    asks: OrderLevel[];
+    /** Unix timestamp (milliseconds) */
+    timestamp?: number;
+}
+/**
+ * A historical trade.
+ */
+export interface Trade {
+    /** Trade ID */
+    id: string;
+    /** Unix timestamp (milliseconds) */
+    timestamp: number;
+    /** Trade price (0.0 to 1.0) */
+    price: number;
+    /** Trade amount (contracts) */
+    amount: number;
+    /** Trade side */
+    side: "buy" | "sell" | "unknown";
+}
+/**
+ * An order (open, filled, or cancelled).
+ */
+export interface Order {
+    /** Order ID */
+    id: string;
+    /** Market ID */
+    marketId: string;
+    /** Outcome ID */
+    outcomeId: string;
+    /** Order side */
+    side: "buy" | "sell";
+    /** Order type */
+    type: "market" | "limit";
+    /** Order amount (contracts) */
+    amount: number;
+    /** Order status */
+    status: string;
+    /** Amount filled */
+    filled: number;
+    /** Amount remaining */
+    remaining: number;
+    /** Unix timestamp (milliseconds) */
+    timestamp: number;
+    /** Limit price (for limit orders) */
+    price?: number;
+    /** Trading fee */
+    fee?: number;
+}
+/**
+ * A current position in a market.
+ */
+export interface Position {
+    /** Market ID */
+    marketId: string;
+    /** Outcome ID */
+    outcomeId: string;
+    /** Outcome label */
+    outcomeLabel: string;
+    /** Position size (positive for long, negative for short) */
+    size: number;
+    /** Average entry price */
+    entryPrice: number;
+    /** Current market price */
+    currentPrice: number;
+    /** Unrealized profit/loss */
+    unrealizedPnL: number;
+    /** Realized profit/loss */
+    realizedPnL?: number;
+}
+/**
+ * Account balance.
+ */
+export interface Balance {
+    /** Currency (e.g., "USDC") */
+    currency: string;
+    /** Total balance */
+    total: number;
+    /** Available for trading */
+    available: number;
+    /** Locked in open orders */
+    locked: number;
+}
+export type CandleInterval = "1m" | "5m" | "15m" | "1h" | "6h" | "1d";
+export type SortOption = "volume" | "liquidity" | "newest";
+export type SearchIn = "title" | "description" | "both";
+export type OrderSide = "buy" | "sell";
+export type OrderType = "market" | "limit";
+/**
+ * Parameters for filtering markets.
+ */
+export interface MarketFilterParams {
+    /** Maximum number of results */
+    limit?: number;
+    /** Pagination offset */
+    offset?: number;
+    /** Sort order */
+    sort?: SortOption;
+    /** Where to search (for searchMarkets) */
+    searchIn?: SearchIn;
+}
+/**
+ * Parameters for fetching historical data.
+ */
+export interface HistoryFilterParams {
+    /** Candle resolution */
+    resolution: CandleInterval;
+    /** Start time */
+    start?: Date;
+    /** End time */
+    end?: Date;
+    /** Maximum number of results */
+    limit?: number;
+}
+/**
+ * Parameters for creating an order.
+ */
+export interface CreateOrderParams {
+    /** Market ID */
+    marketId: string;
+    /** Outcome ID */
+    outcomeId: string;
+    /** Order side (buy/sell) */
+    side: OrderSide;
+    /** Order type (market/limit) */
+    type: OrderType;
+    /** Number of contracts */
+    amount: number;
+    /** Limit price (required for limit orders, 0.0-1.0) */
+    price?: number;
+}

package/dist/esm/pmxt/models.js

@@ -0,0 +1,6 @@
+/**
+ * Data models for PMXT TypeScript SDK.
+ *
+ * These are clean TypeScript interfaces that provide a user-friendly API.
+ */
+export {};

package/dist/esm/pmxt/server-manager.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Server manager for PMXT TypeScript SDK.
+ *
+ * Handles automatic server startup and health checks.
+ */
+export interface ServerManagerOptions {
+    baseUrl?: string;
+    maxRetries?: number;
+    retryDelayMs?: number;
+}
+export declare class ServerManager {
+    private baseUrl;
+    private maxRetries;
+    private retryDelayMs;
+    private api;
+    constructor(options?: ServerManagerOptions);
+    /**
+     * Check if the server is running.
+     */
+    isServerRunning(): Promise<boolean>;
+    /**
+     * Wait for the server to be ready.
+     */
+    private waitForServer;
+    /**
+     * Ensure the server is running, starting it if necessary.
+     */
+    ensureServerRunning(): Promise<void>;
+}

package/dist/esm/pmxt/server-manager.js

@@ -0,0 +1,68 @@
+/**
+ * Server manager for PMXT TypeScript SDK.
+ *
+ * Handles automatic server startup and health checks.
+ */
+import { DefaultApi, Configuration } from "../generated/src/index.js";
+export class ServerManager {
+    baseUrl;
+    maxRetries;
+    retryDelayMs;
+    api;
+    constructor(options = {}) {
+        this.baseUrl = options.baseUrl || "http://localhost:3847";
+        this.maxRetries = options.maxRetries || 30;
+        this.retryDelayMs = options.retryDelayMs || 1000;
+        const config = new Configuration({ basePath: this.baseUrl });
+        this.api = new DefaultApi(config);
+    }
+    /**
+     * Check if the server is running.
+     */
+    async isServerRunning() {
+        try {
+            const response = await this.api.healthCheck();
+            return response.status === "ok";
+        }
+        catch (error) {
+            return false;
+        }
+    }
+    /**
+     * Wait for the server to be ready.
+     */
+    async waitForServer() {
+        for (let i = 0; i < this.maxRetries; i++) {
+            if (await this.isServerRunning()) {
+                return;
+            }
+            await new Promise((resolve) => setTimeout(resolve, this.retryDelayMs));
+        }
+        throw new Error(`Server did not start within ${(this.maxRetries * this.retryDelayMs) / 1000}s`);
+    }
+    /**
+     * Ensure the server is running, starting it if necessary.
+     */
+    async ensureServerRunning() {
+        // Check if already running
+        if (await this.isServerRunning()) {
+            return;
+        }
+        // Try to start the server using pmxt-ensure-server
+        const { spawn } = await import("child_process");
+        try {
+            const proc = spawn("pmxt-ensure-server", [], {
+                detached: true,
+                stdio: "ignore",
+            });
+            proc.unref();
+            // Wait for server to be ready
+            await this.waitForServer();
+        }
+        catch (error) {
+            throw new Error(`Failed to start PMXT server: ${error}\n\n` +
+                `Please ensure 'pmxt-core' is installed: npm install -g pmxt-core\n` +
+                `Or start the server manually: pmxt-server`);
+        }
+    }
+}

package/dist/generated/src/apis/DefaultApi.d.ts

@@ -0,0 +1,268 @@
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
+ *
+ * The version of the OpenAPI document: 0.4.4
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CancelOrderRequest, CreateOrder200Response, CreateOrderRequest, FetchBalance200Response, FetchMarkets200Response, FetchMarketsRequest, FetchOHLCV200Response, FetchOHLCVRequest, FetchOpenOrders200Response, FetchOpenOrdersRequest, FetchOrderBook200Response, FetchOrderBookRequest, FetchPositions200Response, FetchPositionsRequest, FetchTrades200Response, FetchTradesRequest, GetMarketsBySlugRequest, HealthCheck200Response, SearchMarketsRequest } from '../models/index';
+export interface CancelOrderOperationRequest {
+    exchange: CancelOrderOperationExchangeEnum;
+    cancelOrderRequest?: CancelOrderRequest;
+}
+export interface CreateOrderOperationRequest {
+    exchange: CreateOrderOperationExchangeEnum;
+    createOrderRequest?: CreateOrderRequest;
+}
+export interface FetchBalanceRequest {
+    exchange: FetchBalanceExchangeEnum;
+    fetchPositionsRequest?: FetchPositionsRequest;
+}
+export interface FetchMarketsOperationRequest {
+    exchange: FetchMarketsOperationExchangeEnum;
+    fetchMarketsRequest?: FetchMarketsRequest;
+}
+export interface FetchOHLCVOperationRequest {
+    exchange: FetchOHLCVOperationExchangeEnum;
+    fetchOHLCVRequest?: FetchOHLCVRequest;
+}
+export interface FetchOpenOrdersOperationRequest {
+    exchange: FetchOpenOrdersOperationExchangeEnum;
+    fetchOpenOrdersRequest?: FetchOpenOrdersRequest;
+}
+export interface FetchOrderRequest {
+    exchange: FetchOrderExchangeEnum;
+    cancelOrderRequest?: CancelOrderRequest;
+}
+export interface FetchOrderBookOperationRequest {
+    exchange: FetchOrderBookOperationExchangeEnum;
+    fetchOrderBookRequest?: FetchOrderBookRequest;
+}
+export interface FetchPositionsOperationRequest {
+    exchange: FetchPositionsOperationExchangeEnum;
+    fetchPositionsRequest?: FetchPositionsRequest;
+}
+export interface FetchTradesOperationRequest {
+    exchange: FetchTradesOperationExchangeEnum;
+    fetchTradesRequest?: FetchTradesRequest;
+}
+export interface GetMarketsBySlugOperationRequest {
+    exchange: GetMarketsBySlugOperationExchangeEnum;
+    getMarketsBySlugRequest?: GetMarketsBySlugRequest;
+}
+export interface SearchMarketsOperationRequest {
+    exchange: SearchMarketsOperationExchangeEnum;
+    searchMarketsRequest?: SearchMarketsRequest;
+}
+/**
+ *
+ */
+export declare class DefaultApi extends runtime.BaseAPI {
+    /**
+     * Cancel Order
+     */
+    cancelOrderRaw(requestParameters: CancelOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrder200Response>>;
+    /**
+     * Cancel Order
+     */
+    cancelOrder(requestParameters: CancelOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrder200Response>;
+    /**
+     * Create Order
+     */
+    createOrderRaw(requestParameters: CreateOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrder200Response>>;
+    /**
+     * Create Order
+     */
+    createOrder(requestParameters: CreateOrderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrder200Response>;
+    /**
+     * Fetch Balance
+     */
+    fetchBalanceRaw(requestParameters: FetchBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchBalance200Response>>;
+    /**
+     * Fetch Balance
+     */
+    fetchBalance(requestParameters: FetchBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchBalance200Response>;
+    /**
+     * Fetch Markets
+     */
+    fetchMarketsRaw(requestParameters: FetchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchMarkets200Response>>;
+    /**
+     * Fetch Markets
+     */
+    fetchMarkets(requestParameters: FetchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchMarkets200Response>;
+    /**
+     * Fetch OHLCV Candles
+     */
+    fetchOHLCVRaw(requestParameters: FetchOHLCVOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOHLCV200Response>>;
+    /**
+     * Fetch OHLCV Candles
+     */
+    fetchOHLCV(requestParameters: FetchOHLCVOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOHLCV200Response>;
+    /**
+     * Fetch Open Orders
+     */
+    fetchOpenOrdersRaw(requestParameters: FetchOpenOrdersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOpenOrders200Response>>;
+    /**
+     * Fetch Open Orders
+     */
+    fetchOpenOrders(requestParameters: FetchOpenOrdersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOpenOrders200Response>;
+    /**
+     * Fetch Order
+     */
+    fetchOrderRaw(requestParameters: FetchOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrder200Response>>;
+    /**
+     * Fetch Order
+     */
+    fetchOrder(requestParameters: FetchOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrder200Response>;
+    /**
+     * Fetch Order Book
+     */
+    fetchOrderBookRaw(requestParameters: FetchOrderBookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchOrderBook200Response>>;
+    /**
+     * Fetch Order Book
+     */
+    fetchOrderBook(requestParameters: FetchOrderBookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchOrderBook200Response>;
+    /**
+     * Fetch Positions
+     */
+    fetchPositionsRaw(requestParameters: FetchPositionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchPositions200Response>>;
+    /**
+     * Fetch Positions
+     */
+    fetchPositions(requestParameters: FetchPositionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchPositions200Response>;
+    /**
+     * Fetch Trades
+     */
+    fetchTradesRaw(requestParameters: FetchTradesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchTrades200Response>>;
+    /**
+     * Fetch Trades
+     */
+    fetchTrades(requestParameters: FetchTradesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchTrades200Response>;
+    /**
+     * Get Market by Slug
+     */
+    getMarketsBySlugRaw(requestParameters: GetMarketsBySlugOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchMarkets200Response>>;
+    /**
+     * Get Market by Slug
+     */
+    getMarketsBySlug(requestParameters: GetMarketsBySlugOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchMarkets200Response>;
+    /**
+     * Server Health Check
+     */
+    healthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HealthCheck200Response>>;
+    /**
+     * Server Health Check
+     */
+    healthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HealthCheck200Response>;
+    /**
+     * Search for markets by title or description.
+     * Search Markets
+     */
+    searchMarketsRaw(requestParameters: SearchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FetchMarkets200Response>>;
+    /**
+     * Search for markets by title or description.
+     * Search Markets
+     */
+    searchMarkets(requestParameters: SearchMarketsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FetchMarkets200Response>;
+}
+/**
+ * @export
+ */
+export declare const CancelOrderOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type CancelOrderOperationExchangeEnum = typeof CancelOrderOperationExchangeEnum[keyof typeof CancelOrderOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const CreateOrderOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type CreateOrderOperationExchangeEnum = typeof CreateOrderOperationExchangeEnum[keyof typeof CreateOrderOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchBalanceExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchBalanceExchangeEnum = typeof FetchBalanceExchangeEnum[keyof typeof FetchBalanceExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchMarketsOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchMarketsOperationExchangeEnum = typeof FetchMarketsOperationExchangeEnum[keyof typeof FetchMarketsOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOHLCVOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOHLCVOperationExchangeEnum = typeof FetchOHLCVOperationExchangeEnum[keyof typeof FetchOHLCVOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOpenOrdersOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOpenOrdersOperationExchangeEnum = typeof FetchOpenOrdersOperationExchangeEnum[keyof typeof FetchOpenOrdersOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOrderExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOrderExchangeEnum = typeof FetchOrderExchangeEnum[keyof typeof FetchOrderExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchOrderBookOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchOrderBookOperationExchangeEnum = typeof FetchOrderBookOperationExchangeEnum[keyof typeof FetchOrderBookOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchPositionsOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchPositionsOperationExchangeEnum = typeof FetchPositionsOperationExchangeEnum[keyof typeof FetchPositionsOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const FetchTradesOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type FetchTradesOperationExchangeEnum = typeof FetchTradesOperationExchangeEnum[keyof typeof FetchTradesOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const GetMarketsBySlugOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type GetMarketsBySlugOperationExchangeEnum = typeof GetMarketsBySlugOperationExchangeEnum[keyof typeof GetMarketsBySlugOperationExchangeEnum];
+/**
+ * @export
+ */
+export declare const SearchMarketsOperationExchangeEnum: {
+    readonly Polymarket: "polymarket";
+    readonly Kalshi: "kalshi";
+};
+export type SearchMarketsOperationExchangeEnum = typeof SearchMarketsOperationExchangeEnum[keyof typeof SearchMarketsOperationExchangeEnum];